pact 1.0.7 → 1.0.8

data/CHANGELOG.md

@@ -1,8 +1,14 @@
-### 1.0.7 (11 September 2012)
+### 1.0.8 (13 September 2013)
+
+* Added validation to ensure that a Term has both a matcher and a generate value, and that the value to generate matches the given regular expression [Beth Skurrie]
+
+* Added the SomethingLike class that does a structure diff on anything contianed within in it. Will change the name when we can think of something better! [Beth Skurrie, Greg Dziemidowicz]
+
+### 1.0.7 (11 September 2013)
 
 * Allow request query to be a Pact Term. [Seb Glazebrook]
 
-### 1.0.6 (11 September 2012)
+### 1.0.6 (11 September 2013)
 
 * Made reports dir configurable [Beth Skurrie]
 * Changed the way the pact files are configured. They are now in the Pact.service_provider block in the pact_helper file. Require 'pact/tasks' in the Rakefile and run 'rake pact:verify' instead of setting up custom tasks. [Beth Skurrie]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pact (1.0.7)
+    pact (1.0.8)
       awesome_print (~> 1.1.0)
       find_a_port (~> 1.0.1)
       hashie (~> 2.0)

data/lib/pact/consumer.rb

@@ -7,4 +7,5 @@ require_relative 'consumer/mock_service'
 require_relative 'consumer/mock_service_client'
 require_relative 'consumer/app_manager'
 require_relative 'term'
+require_relative 'something_like'
 require_relative 'request'

data/lib/pact/consumer_contract/consumer_contract.rb

@@ -4,6 +4,8 @@ require 'pact/json_warning'
 require 'date'
 require 'pact/version'
 require 'open-uri'
+require 'pact/term'
+require 'pact/something_like'
 require_relative 'service_consumer'
 require_relative 'service_provider'
 require_relative 'interaction'

data/lib/pact/matchers/matchers.rb

@@ -33,6 +33,7 @@ module Pact
       when Array then array_diff(expected, actual, options)
       when Pact::Term then diff(expected.matcher, actual, options)
       when Regexp then regexp_diff(expected, actual, options)
+      when Pact::SomethingLike then diff(expected.contents, actual, options.merge(:structure => true))
       else object_diff(expected, actual, options)
       end
     end

data/lib/pact/provider.rb

@@ -1,4 +1,3 @@
 require 'pact/configuration'
 require 'pact/provider/dsl'
-require 'pact/provider/client_project_pact_helper'
 require 'pact/provider/pact_spec_runner'

data/lib/pact/request.rb

@@ -1,4 +1,5 @@
 require 'pact/matchers'
+require 'pact/reification'
 
 module Pact
 

data/lib/pact/something_like.rb

@@ -0,0 +1,31 @@
+module Pact
+
+  class SomethingLike
+    attr_reader :contents
+
+    def initialize contents
+      @contents = contents
+    end
+
+    def as_json
+      {
+        :json_class => self.class.name,
+        :contents => contents
+      }
+    end
+
+    def to_json opts = {}
+      as_json.to_json opts
+    end
+
+    def self.json_create hash
+      new(hash['contents'])
+    end
+
+    def generate
+      contents
+    end
+  end
+end
+
+

data/lib/pact/term.rb

@@ -10,6 +10,9 @@ module Pact
     def initialize(attributes = {})
       @generate = attributes[:generate]
       @matcher = attributes[:matcher]
+      raise "Please specify a matcher for the Term" unless @matcher != nil
+      raise "Please specify a value to generate for the Term" unless @generate != nil
+      raise "Value to generate \"#{@generate}\" does not match regular expression #{@matcher}" unless @generate =~ @matcher
     end
 
     def to_json(options = {})
@@ -37,7 +40,7 @@ module Pact
     end
 
     def empty?
-      generate ? false : true
+      false
     end
 
   end

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.0.7"
+  VERSION = "1.0.8"
 end

data/lib/tasks/pact.rake

@@ -5,6 +5,7 @@ namespace :pact do
   task :verify do
     require 'pact/provider'
     require 'pact/pact_task_helper'
+    require 'pact/provider/client_project_pact_helper'
 
     include PactTaskHelper
 

data/spec/features/consumption_spec.rb

@@ -39,7 +39,7 @@ describe "A service consumer side of a pact", :pact => true  do
       method: :post,
       path: '/donuts',
       body: {
-        "name" => Pact::Term.new(matcher: /Bob/)
+        "name" => Pact::Term.new(matcher: /Bob/, generate: 'Bob')
       },
       headers: {'Accept' => 'text/plain', "Content-Type" => 'application/json'}
     }).
@@ -56,7 +56,7 @@ describe "A service consumer side of a pact", :pact => true  do
       status: 200,
       body: /deleted/
     })
-    bob_service. 
+    bob_service.
       upon_receiving('an update alligators request').with({
         method: :put,
         path: '/alligators',

data/spec/lib/pact/matchers/matchers_spec.rb

@@ -1,10 +1,25 @@
 require 'spec_helper'
 require 'pact/term'
+require 'pact/something_like'
 require 'pact/matchers'
 
 describe Pact::Matchers do
   include Pact::Matchers
 
+  describe 'matching with something like' do
+
+    context 'when the actual is something like the expected' do
+      let(:expected) { Pact::SomethingLike.new( { a: 1 } ) }
+      let(:actual) { { a: 2} }
+
+      it 'returns an empty diff' do
+        expect(diff(expected, actual)).to eq({})
+      end
+
+    end
+
+  end
+
   describe 'option {allow_unexpected_keys: false}' do
     context "when an unexpected key is found" do
       let(:expected) { {:a => 1} }
@@ -314,7 +329,7 @@ describe Pact::Matchers do
     end
 
     context "a deep mismatch" do
-      subject { {a:  {b: { c: [1,2]}, d: { e: Pact::Term.new(matcher: /a/)}}, f: 1, g: {h: 99}} }
+      subject { {a:  {b: { c: [1,2]}, d: { e: Pact::Term.new(matcher: /a/, generate: 'apple')}}, f: 1, g: {h: 99}} }
       let(:actual) { {a:  {b: { c: [1,2]}, d: { e: 'food'}}, f: "thing"} }
       let(:difference) { {:a=>{:d=>{:e=>{:expected=>/a/, :actual=>"food"}}}, :f=>{:expected=>1, :actual=>"thing"}, :g=>{:expected=>{:h=>99}, :actual=> Pact::Matchers::KeyNotFound.new}} }
 
@@ -325,7 +340,7 @@ describe Pact::Matchers do
 
 
     context "where a Pact::Term is found that matches the actual value" do
-      subject { {:a => Pact::Term.new(:matcher => /a/)} }
+      subject { {:a => Pact::Term.new(:matcher => /a/, :generate => 'apple')} }
       let(:actual) { {:a => "apple" } }
 
       it 'does not include this in the diff' do
@@ -371,7 +386,7 @@ describe Pact::Matchers do
     end
 
     context "when an array that matches the Pact::Term is found" do
-      subject { [Pact::Term.new(:matcher => /4/),"5","6"] }
+      subject { [Pact::Term.new(:matcher => /4/, :generate => '4'),"5","6"] }
       let(:actual) { ["4","5","6"] }
 
       it 'includes this in the diff' do

data/spec/lib/pact/provider/test_methods_spec.rb

@@ -38,7 +38,7 @@ module Pact::Provider
 
         context 'Term query' do
 
-          let(:query) { Pact::Term.new(generate: 'query') }
+          let(:query) { Pact::Term.new(generate: 'query', matcher: /q/) }
 
           it 'appends the Term\'s generate to the path' do
             expect(@path).to eq('path?query')

data/spec/lib/pact/request_spec.rb

@@ -251,7 +251,7 @@ module Pact
         let(:expected_body) do
           {
             name: 'Bob',
-            customer_id: Term.new(matcher: /CN.*/)
+            customer_id: Term.new(matcher: /CN.*/, generate: 'CN789')
           }
         end
 
@@ -271,7 +271,7 @@ module Pact
         let(:expected_body) do
           {
             name: 'Bob',
-            customer_id: Term.new(matcher: /foo/)
+            customer_id: Term.new(matcher: /foo/, generate: 'fooool')
           }
         end
 

data/spec/lib/pact/term_spec.rb

@@ -3,6 +3,38 @@ require 'spec_helper'
 module Pact
   describe Term do
 
+    describe 'initialize' do
+      let(:matcher) { /e/ }
+      let(:generate) { 'apple'}
+      subject { Term.new(generate: generate, matcher: matcher) }
+      context "when a matcher and generate are specified" do
+        context "when the matcher matches the generated value" do
+          it 'does not raise an exception' do
+            subject
+          end
+        end
+
+        context "when the matcher does not match the generated value" do
+          let(:generate) { 'banana' }
+          it 'raises an exception' do
+            expect { subject }.to raise_error /does not match/
+          end
+        end
+      end
+      context 'when a matcher is not specified' do
+        let(:matcher) { nil }
+        it 'raises an exception' do
+          expect { subject }.to raise_error /Please specify a matcher/
+        end
+      end
+      context 'when a generate is not specified' do
+        let(:generate) { nil }
+        it 'raises an exception' do
+          expect { subject }.to raise_error /Please specify a value/
+        end
+      end
+    end
+
     describe "equality" do
       context "when the matcher and generate attrs are the same" do
         let(:this) { Term.new(generate: 'A', matcher: /A/) }
@@ -14,8 +46,8 @@ module Pact
       end
 
       context "when the generate attrs are different" do
-        let(:this) { Term.new(generate: /A/) }
-        let(:that) { Term.new(generate: /B/) }
+        let(:this) { Term.new(generate: 'A', matcher: /.*/) }
+        let(:that) { Term.new(generate: 'B', matcher: /.*/) }
 
         it "is not equal" do
           expect(this).to_not eq that
@@ -23,8 +55,8 @@ module Pact
       end
 
       context "when the matcher attrs are different" do
-        let(:this) { Term.new(matcher: 'A') }
-        let(:that) { Term.new(matcher: 'B') }
+        let(:this) { Term.new(matcher: /A/, generate: 'AB') }
+        let(:that) { Term.new(matcher: /B/, generate: 'AB') }
 
         it "is not equal" do
           expect(this).to_not eq that
@@ -34,25 +66,10 @@ module Pact
 
     describe 'empty?' do
 
-      subject { Term.new(generate: generate, matcher: /some matcher/) }
+      subject { Term.new(generate: 'some', matcher: /some/) }
 
-      context 'with generate' do
-
-        let(:generate) { 'generate here'}
-
-        it 'is not empty' do
-          expect(subject).to_not be_empty
-        end
-
-      end
-
-      context 'without generate' do
-
-        let(:generate) { nil }
-
-        it 'is empty' do
-          expect(subject).to be_empty
-        end
+      it 'should return false' do
+        expect(subject).to_not be_empty
       end
 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -305,6 +305,7 @@ files:
 - lib/pact/provider/verification_report.rb
 - lib/pact/reification.rb
 - lib/pact/request.rb
+- lib/pact/something_like.rb
 - lib/pact/tasks.rb
 - lib/pact/term.rb
 - lib/pact/verification_task.rb