pact-support 1.20.2 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f09baafff639ab44ab0f956cf99de01d19e2a6bde94fd02b34a62209e2781e4
-  data.tar.gz: 50b9785ecdbf774c579755207f9cfa23327377ac355ac3abfe02cfbf9b828bf0
+  metadata.gz: ff89b1f300df93010c7b5820db53c8433fb8793ed895e8671c59b594f28008e4
+  data.tar.gz: 192212e7600f9c1be43e3817b479d59293582ad324e32262513a8db4982d850d
 SHA512:
-  metadata.gz: ce4bd3ca61bae08e204bae1e8d2f54b0dd5b2f22257029c9bf48766ae512e3f6ac014906302116298c148a034120e8b7701c5ad7badb975226f91d21ceb0ddb1
-  data.tar.gz: ffb5e753019de9d6090324c3ae5b8096ef4131e34cb8e1e39f1012e55ec493a0ca41a65462f78c4b62e71cec90f8641067d7e58e2df419a532ce8b96570ecce2
+  metadata.gz: b9335620e66ea4d6227973a7c2ca94f10bded7f05f9cdc8621715960619fcbde63e8d02d84c418027a4bde925d02dbc547641f8a73a34cb4269611016c0044f7
+  data.tar.gz: db26dea284a359a2c0b8a4e7db2a1dac2c488f228de11e2277ca4d154b342bf1338a5b574bab9326e46e05b8a0f6c21c19f2ef1899b62811f23b057ba4d57808

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+<a name="v1.21.0"></a>
+### v1.21.0 (2024-11-28)
+
+#### Features
+
+* add like_integer / like_decimal helpers	 ([75a36cd](/../../commit/75a36cd))
+* add v3/v4 generators (thanks @slt)	 ([fe04975](/../../commit/fe04975))
+
+#### Bug Fixes
+
+* add blank lines to empty hashs - json 2.8.x regression	 ([66910bd](/../../commit/66910bd))
+
 <a name="v1.20.2"></a>
 ### v1.20.2 (2024-10-23)
 

data/README.md

@@ -4,3 +4,69 @@
 [![Join the chat at https://pact-foundation.slack.com/](https://img.shields.io/badge/chat-on%20slack-blue.svg?logo=slack)](https://slack.pact.io)
 
 Provides shared code for the Pact gems
+
+## Compatibility
+
+<details><summary>Specification Compatibility</summary>
+
+| Version  | Stable | [Spec] Compatibility | 
+| -------  | ------ | -------------------- |
+| 1.x.x    | Yes    | 2, 3\*               |
+
+_\*_ v3 support is limited to the subset of functionality required to enable language inter-operable [Message support].
+
+- See V3 tracking [issue](https://github.com/pact-foundation/pact-ruby/issues/318).
+- See V4 tracking [issue](https://github.com/pact-foundation/pact-ruby/issues/319).
+
+Want V3/V4 support now? See the new standalone [pact-verifier](https://github.com/pact-foundation/pact-reference/tree/master/rust/pact_verifier_cli#standalone-pact-verifier)
+
+[message support]: https://github.com/pact-foundation/pact-specification/tree/version-3#introduces-messages-for-services-that-communicate-via-event-streams-and-message-queues
+
+</details>
+
+### Supported matching rules
+
+| matcher       | Spec Version | Implemented | Usage|
+|---------------|--------------|-------------|-------------|
+| Equality      | V1           |   |    |
+| Regex         | V2           | ✅  | `Pact.term(generate, matcher)` |
+| Type          | V2           | ✅  | `Pact.like(generate)` |
+| MinType       | V2           | ✅  | `Pact.each_like(generate, min: <val>)` |
+| MaxType       | V2           |   |    |
+| MinMaxType    | V2           |   |    |
+| Include       | V3           |   |    |
+| Integer       | V3           |   |    |
+| Decimal       | V3           |   |    |
+| Number        | V3           |   |    |
+| Timestamp     | V3           |   |    |
+| Time          | V3           |   |    |
+| Date          | V3           |   |    |
+| Null          | V3           |   |    |
+| Boolean       | V3           |   |    |
+| ContentType   | V3           |   |    |
+| Values        | V3           |   |    |
+| ArrayContains | V4           |   |    |
+| StatusCode    | V4           |   |    |
+| NotEmpty      | V4           |   |    |
+| Semver        | V4           |   |    |
+| EachKey       | V4           |   |    |
+| EachValue     | V4           |   |    |
+
+### Supported generators
+
+Currently limited to provider verification only. No current way to set in consumer tests.
+
+| Generator                | Spec Version | Implemented |
+|------------------------|--------------|----|
+| RandomInt              | V3           | ✅ |
+| RandomDecimal          | V3           | ✅ |
+| RandomHexadecimal      | V3           | ✅ |
+| RandomString           | V3           | ✅ |
+| Regex                  | V3           | ✅ |
+| Uuid                   | V3/V4        | ✅ |
+| Date                   | V3           | ✅ |
+| Time                   | V3           | ✅ |
+| DateTime               | V3           | ✅ |
+| RandomBoolean          | V3           | ✅ |
+| ProviderState          | V4           | ✅ |
+| MockServerURL          | V4           | 🚧 |

data/lib/pact/generator/date.rb

@@ -0,0 +1,62 @@
+require 'date'
+
+module Pact
+  module Generator
+    # Date provides the time generator which will give the current date in the defined format
+    class Date
+      def can_generate?(hash)
+        hash.key?('type') && hash['type'] == type
+      end
+
+      def call(hash, _params = nil, _example_value = nil)
+        format = hash['format'] || default_format
+        ::Time.now.strftime(convert_from_java_simple_date_format(format))
+      end
+
+      def type
+        'Date'
+      end
+
+      def default_format
+        'yyyy-MM-dd'
+      end
+
+      # Format for the pact specficiation should be the Java DateTimeFormmater
+      # This tries to convert to something Ruby can format.
+      def convert_from_java_simple_date_format(format)
+        # Year
+        format.sub!(/(?<!%)y{4,}/, '%Y')
+        format.sub!(/(?<!%)y{1,}/, '%y')
+
+        # Month
+        format.sub!(/(?<!%)M{4,}/, '%B')
+        format.sub!(/(?<!%)M{3}/, '%b')
+        format.sub!(/(?<!%)M{1,2}/, '%m')
+
+        # Week
+        format.sub!(/(?<!%)M{1,}/, '%W')
+
+        # Day
+        format.sub!(/(?<!%)D{1,}/, '%j')
+        format.sub!(/(?<!%)d{1,}/, '%d')
+        format.sub!(/(?<!%)E{4,}/, '%A')
+        format.sub!(/(?<!%)D{1,}/, '%a')
+        format.sub!(/(?<!%)u{1,}/, '%u')
+
+        # Time
+        format.sub!(/(?<!%)a{1,}/, '%p')
+        format.sub!(/(?<!%)k{1,}/, '%H')
+        format.sub!(/(?<!%)n{1,}/, '%M')
+        format.sub!(/(?<!%)s{1,}/, '%S')
+        format.sub!(/(?<!%)S{1,}/, '%L')
+
+        # Timezone
+        format.sub!(/(?<!%)z{1,}/, '%z')
+        format.sub!(/(?<!%)Z{1,}/, '%z')
+        format.sub!(/(?<!%)X{1,}/, '%Z')
+
+        format
+      end
+    end
+  end
+end

data/lib/pact/generator/datetime.rb

@@ -0,0 +1,16 @@
+require 'date'
+
+module Pact
+  module Generator
+    # DateTime provides the time generator which will give the current date time in the defined format
+    class DateTime < Date
+      def type
+        'DateTime'
+      end
+
+      def default_format
+        'yyyy-MM-dd HH:mm'
+      end
+    end
+  end
+end

data/lib/pact/generator/provider_state.rb

@@ -0,0 +1,53 @@
+require 'pact/logging'
+
+module Pact
+  module Generator
+    # ProviderState provides the provider state generator which will inject
+    # values provided by the provider state setup url.
+    class ProviderState
+      include Pact::Logging
+
+      # rewrite of https://github.com/DiUS/pact-jvm/blob/master/core/support/src/main/kotlin/au/com/dius/pact/core/support/expressions/ExpressionParser.kt#L27
+      VALUES_SEPARATOR = ','
+      START_EXPRESSION = "\${"
+      END_EXPRESSION = '}'
+
+      def can_generate?(hash)
+        hash.key?('type') && hash['type'] == 'ProviderState'
+      end
+
+      def call(hash, params = nil, _example_value = nil)
+        params ||= {}
+        parse_expression hash['expression'], params
+      end
+
+      def parse_expression(expression, params)
+        return_string = []
+        buffer = expression
+        # initial value
+        position = buffer.index(START_EXPRESSION)
+
+        while position && position >= 0
+          if position.positive?
+            # add string
+            return_string.push(buffer[0...position])
+          end
+          end_position = buffer.index(END_EXPRESSION, position)
+          raise 'Missing closing brace in expression string' if !end_position || end_position.negative?
+
+          variable = buffer[position + 2...end_position]
+
+          logger.info "Could not subsitute provider state key #{variable}, have #{params}" unless params[variable]
+
+          expression = params[variable] || ''
+          return_string.push(expression)
+
+          buffer = buffer[end_position + 1...-1]
+          position = buffer.index(START_EXPRESSION)
+        end
+
+        return_string.join('')
+      end
+    end
+  end
+end

data/lib/pact/generator/random_boolean.rb

@@ -0,0 +1,14 @@
+module Pact
+  module Generator
+    # Boolean provides the boolean generator which will give a true or false value
+    class RandomBoolean
+      def can_generate?(hash)
+        hash.key?('type') && hash['type'] == 'RandomBoolean'
+      end
+
+      def call(_hash, _params = nil, _example_value = nil)
+        [true, false].sample
+      end
+    end
+  end
+end

data/lib/pact/generator/random_decimal.rb

@@ -0,0 +1,37 @@
+require 'bigdecimal'
+
+module Pact
+  module Generator
+    # RandomDecimal provides the random decimal generator which will generate a decimal value of digits length
+    class RandomDecimal
+      def can_generate?(hash)
+        hash.key?('type') && hash['type'] == 'RandomDecimal'
+      end
+
+      def call(hash, _params = nil, _example_value = nil)
+        digits = hash['digits'] || 6
+
+        raise 'RandomDecimalGenerator digits must be > 0, got $digits' if digits < 1
+
+        return rand(0..9) if digits == 1
+
+        return rand(0..9) + rand(1..9) / 10 if digits == 2
+
+        pos = rand(1..digits - 1)
+        precision = digits - pos
+        integers = ''
+        decimals = ''
+        while pos.positive?
+          integers += String(rand(1..9))
+          pos -= 1
+        end
+        while precision.positive?
+          decimals += String(rand(1..9))
+          precision -= 1
+        end
+
+        Float("#{integers}.#{decimals}")
+      end
+    end
+  end
+end

data/lib/pact/generator/random_hexadecimal.rb

@@ -0,0 +1,19 @@
+require 'securerandom'
+
+module Pact
+  module Generator
+    # RandomHexadecimal provides the random hexadecimal generator which will generate a hexadecimal
+    class RandomHexadecimal
+      def can_generate?(hash)
+        hash.key?('type') && hash['type'] == 'RandomHexadecimal'
+      end
+
+      def call(hash, _params = nil, _example_value = nil)
+        digits = hash['digits'] || 8
+        bytes = (digits / 2).ceil
+        string = SecureRandom.hex(bytes)
+        string[0, digits]
+      end
+    end
+  end
+end

data/lib/pact/generator/random_int.rb

@@ -0,0 +1,16 @@
+module Pact
+  module Generator
+    # RandomInt provides the random int generator which generate a random integer, with a min/max
+    class RandomInt
+      def can_generate?(hash)
+        hash.key?('type') && hash['type'] == 'RandomInt'
+      end
+
+      def call(hash, _params = nil, _example_value = nil)
+        min = hash['min'] || 0
+        max = hash['max'] || 2_147_483_647
+        rand(min..max)
+      end
+    end
+  end
+end

data/lib/pact/generator/random_string.rb

@@ -0,0 +1,16 @@
+module Pact
+  module Generator
+    # RandomString provides the random string generator which generate a random string of size length
+    class RandomString
+      def can_generate?(hash)
+        hash.key?('type') && hash['type'] == 'RandomString'
+      end
+
+      def call(hash, _params = nil, _example_value = nil)
+        size = hash['size'] || 20
+        string = rand(36**(size + 2)).to_s(36)
+        string[0, size]
+      end
+    end
+  end
+end

data/lib/pact/generator/regex.rb

@@ -0,0 +1,17 @@
+require 'string_pattern'
+
+module Pact
+  module Generator
+    # Regex provides the regex generator which will generate a value based on the regex pattern provided
+    class Regex
+      def can_generate?(hash)
+        hash.key?('type') && hash['type'] == 'Regex'
+      end
+
+      def call(hash, _params = nil, _example_value = nil)
+        pattern = hash['pattern'] || ''
+        StringPattern.generate(Regexp.new(pattern))
+      end
+    end
+  end
+end

data/lib/pact/generator/time.rb

@@ -0,0 +1,16 @@
+require 'date'
+
+module Pact
+  module Generator
+    # Time provides the time generator which will give the current time in the defined format
+    class Time < Date
+      def type
+        'Time'
+      end
+
+      def default_format
+        'HH:mm'
+      end
+    end
+  end
+end

data/lib/pact/generator/uuid.rb

@@ -0,0 +1,19 @@
+require 'securerandom'
+
+module Pact
+  module Generator
+    # Uuid provides the uuid generator
+    class Uuid
+      def can_generate?(hash)
+        hash.key?('type') && hash['type'] == 'Uuid'
+      end
+
+      # If we had the example value, we could determine what type of uuid
+      # to send, this is what pact-jvm does
+      # See https://github.com/pact-foundation/pact-jvm/blob/master/core/model/src/main/kotlin/au/com/dius/pact/core/model/generators/Generator.kt
+      def call(_hash, _params = nil, _example_value = nil)
+        SecureRandom.uuid
+      end
+    end
+  end
+end

data/lib/pact/generators.rb

@@ -0,0 +1,64 @@
+require 'pact/generator/random_boolean'
+require 'pact/generator/date'
+require 'pact/generator/datetime'
+require 'pact/generator/provider_state'
+require 'pact/generator/random_decimal'
+require 'pact/generator/random_hexadecimal'
+require 'pact/generator/random_int'
+require 'pact/generator/random_string'
+require 'pact/generator/regex'
+require 'pact/generator/time'
+require 'pact/generator/uuid'
+require 'pact/matching_rules/jsonpath'
+require 'pact/matching_rules/v3/extract'
+require 'jsonpath'
+
+module Pact
+    class Generators
+      def self.add_generator(generator)
+        generators.unshift(generator)
+      end
+
+      def self.generators
+        @generators ||= []
+      end
+
+      def self.execute_generators(object, state_params = nil, example_value = nil)
+        generators.each do |parser|
+          return parser.call(object, state_params, example_value) if parser.can_generate?(object)
+        end
+
+        raise Pact::UnrecognizePactFormatError, "This document does not use a recognised Pact generator: #{object}"
+      end
+
+      def self.apply_generators(expected_request, component, example_value, state_params)
+        # Latest pact-support is required to have generators exposed
+        if expected_request.methods.include?(:generators) && expected_request.generators[component]
+          # Some component will have single generator without selectors, i.e. path
+          generators = expected_request.generators[component]
+          if generators.is_a?(Hash) && generators.key?('type')
+            return execute_generators(generators, state_params, example_value)
+          end
+
+          generators.each do |selector, generator|
+            val = JsonPath.new(selector).on(example_value)
+            replace = execute_generators(generator, state_params, val)
+            example_value = JsonPath.for(example_value).gsub(selector) { |_v| replace }.to_hash
+          end
+        end
+        example_value
+      end
+
+      add_generator(Generator::RandomBoolean.new)
+      add_generator(Generator::Date.new)
+      add_generator(Generator::DateTime.new)
+      add_generator(Generator::ProviderState.new)
+      add_generator(Generator::RandomDecimal.new)
+      add_generator(Generator::RandomHexadecimal.new)
+      add_generator(Generator::RandomInt.new)
+      add_generator(Generator::RandomString.new)
+      add_generator(Generator::Regex.new)
+      add_generator(Generator::Time.new)
+      add_generator(Generator::Uuid.new)
+    end
+end

data/lib/pact/helpers.rb

@@ -47,6 +47,16 @@ module Pact
       Pact::Term.new(generate: date, matcher: /^\d{4}-[01]\d-[0-3]\d$/)
     end
 
+    # regex matched with pact-jvm 
+    # https://github.com/pact-foundation/pact-jvm/blob/00442e6df51e5be906ed470b19859246312e5c83/core/matchers/src/main/kotlin/au/com/dius/pact/core/matchers/MatcherExecutor.kt#L56-L59
+    def like_integer int
+      Pact::Term.new(generate: int, matcher: /^-?\d+$/)
+    end
+
+    def like_decimal float
+      Pact::Term.new(generate: float, matcher: /^0|-?\d+\.\d*$/)
+    end
+
     def like_datetime_rfc822 datetime
       Pact::Term.new(
         generate: datetime,

data/lib/pact/matchers/matchers.rb

@@ -61,6 +61,12 @@ module Pact
     alias_method :structure_diff, :type_diff # Backwards compatibility
 
     def term_diff term, actual, options
+      if actual.is_a?(Float) || actual.is_a?(Integer)
+        options[:original] = actual
+        options[:was_float] = actual.is_a?(Float)
+        options[:was_int] = actual.is_a?(Integer)
+        actual = actual.to_s
+      end
       if actual.is_a?(String)
         actual_term_diff term, actual, options
       else
@@ -72,7 +78,7 @@ module Pact
       if term.matcher.match(actual)
         NO_DIFF
       else
-        RegexpDifference.new term.matcher, actual, "Expected a String matching #{term.matcher.inspect} (like #{term.generate.inspect}) but got #{actual.inspect} at <path>"
+        RegexpDifference.new term.matcher, options[:original] ||= actual, "Expected a Value matching #{term.matcher.inspect} (like #{term.generate.inspect}) but got #{options[:was_float] || options[:was_int] ? class_name_with_value_in_brackets(options[:original]) : actual.inspect} at <path>"
       end
     end
 

data/lib/pact/matchers/unix_diff_formatter.rb

@@ -62,6 +62,8 @@ module Pact
         begin
           # Can't think of an elegant way to check if we can pretty generate other than to try it and maybe fail
           json = fix_blank_lines_in_empty_hashes JSON.pretty_generate(comparable)
+          json = add_blank_lines_in_empty_hashes json
+          json = add_blank_lines_in_empty_arrays json
           add_comma_to_end_of_arrays json
         rescue JSON::GeneratorError
           comparable.to_s

data/lib/pact/shared/jruby_support.rb

@@ -14,5 +14,14 @@ module Pact
       json.gsub(/({\n)\n(\s*})/,'\1\2')
     end
 
+    # preserve pre json 2.8.x behaviour
+    # https://github.com/ruby/json/pull/626
+    def add_blank_lines_in_empty_hashes(json)
+      json.gsub(/({\s*})/, "{\n  }")
+    end
+
+    def add_blank_lines_in_empty_arrays(json)
+      json.gsub(/\[\s*\]/, "[\n  ]")
+    end
   end
 end

data/lib/pact/support/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module Support
-    VERSION = "1.20.2"
+    VERSION = "1.21.0"
   end
 end

data/lib/pact/term.rb

@@ -29,7 +29,11 @@ module Pact
       @matcher = attributes[:matcher]
       raise Pact::Error.new("Please specify a matcher for the Term") unless @matcher != nil
       raise Pact::Error.new("Please specify a value to generate for the Term") unless @generate != nil
-      raise Pact::Error.new("Value to generate '#{@generate}' does not match regular expression #{@matcher.inspect}") unless @generate =~ @matcher
+      if @generate.is_a?(Float) || @generate.is_a?(Integer)
+        raise Pact::Error.new("#{@generate.is_a?(Float) ? "Float" : "Integer"} Value to generate '#{@generate}' does not match regular expression #{@matcher.inspect} when converted to string") unless @generate.to_s =~ @matcher
+      else
+        raise Pact::Error.new("Value to generate '#{@generate}' does not match regular expression #{@matcher.inspect}") unless @generate =~ @matcher
+      end
     end
 
     def to_hash

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-support
 version: !ruby/object:Gem::Version
-  version: 1.20.2
+  version: 1.21.0
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-23 00:00:00.000000000 Z
+date: 2024-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -70,6 +70,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: string_pattern
+  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: jsonpath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -281,6 +309,18 @@ files:
 - lib/pact/consumer_contract/service_provider.rb
 - lib/pact/consumer_contract/string_with_matching_rules.rb
 - lib/pact/errors.rb
+- lib/pact/generator/date.rb
+- lib/pact/generator/datetime.rb
+- lib/pact/generator/provider_state.rb
+- lib/pact/generator/random_boolean.rb
+- lib/pact/generator/random_decimal.rb
+- lib/pact/generator/random_hexadecimal.rb
+- lib/pact/generator/random_int.rb
+- lib/pact/generator/random_string.rb
+- lib/pact/generator/regex.rb
+- lib/pact/generator/time.rb
+- lib/pact/generator/uuid.rb
+- lib/pact/generators.rb
 - lib/pact/helpers.rb
 - lib/pact/http/authorization_header_redactor.rb
 - lib/pact/logging.rb
@@ -347,7 +387,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Shared code for Pact gems