refactor: change ExtractDiffMessages to return an array instead of a string

Author: bethesque

lib/pact/matchers/extract_diff_messages.rb

@@ -1,3 +1,4 @@
+# @api public. Used by lib/pact/provider/rspec/pact_broker_formatter.rb
 module Pact
   module Matchers
     class ExtractDiffMessages
@@ -13,17 +14,21 @@ def self.call diff, options = {}
       end
 
       def to_hash
-        diff
+        to_a
       end
 
       def call
-        to_s
+        to_a
       end
 
       def to_s
         diff_messages(diff).join("\n")
       end
 
+      def to_a
+        diff_messages(diff)
+      end
+
       def diff_messages obj, path = [], messages = []
         case obj
         when Hash then handle_hash obj, path, messages
@@ -51,7 +56,7 @@ def handle_array array, path, messages
 
       def handle_difference difference, path, messages
         if difference.message
-          message = "* #{difference.message}"
+          message = difference.message
           message = message.gsub("<path>", path_to_s(path))
           message = message.gsub("<parent_path>", parent_path_to_s(path))
           messages << message

lib/pact/matchers/unix_diff_formatter.rb

@@ -17,7 +17,7 @@ def initialize diff, options = {}
         @actual = options.fetch(:actual, {})
         @include_explanation = options.fetch(:include_explanation, true)
         @differ = Pact::Matchers::Differ.new(@colour)
-        @messages = Pact::Matchers::ExtractDiffMessages.call(diff)
+        @messages = Pact::Matchers::ExtractDiffMessages.call(diff).collect{ | message| "* #{message}" }.join("\n")
       end
 
       def self.call diff, options = {}

spec/lib/pact/matchers/extract_diff_messages_spec.rb

@@ -4,62 +4,62 @@ module Pact
   module Matchers
     describe ExtractDiffMessages do
 
-      subject { ExtractDiffMessages.call(diff) }
+      subject { ExtractDiffMessages.call(diff).join("\n") }
 
       context "<path> with a diff in a Hash" do
         let(:diff) { {a: Difference.new(nil, nil, "There was a difference at <path>") } }
 
-        it { is_expected.to eq "* There was a difference at $.a" }
+        it { is_expected.to eq "There was a difference at $.a" }
       end
 
       context "<parent_path> with a diff in a Hash" do
         let(:diff) { {a: Difference.new(nil, nil, "There was a difference at <parent_path>") } }
 
-        it { is_expected.to eq "* There was a difference at $" }
+        it { is_expected.to eq "There was a difference at $" }
       end
 
       context "<path> with a diff in a nested Hash" do
         let(:diff) { {a: {b: Difference.new(nil, nil, "There was a difference at <path>")}} }
 
-        it { is_expected.to eq "* There was a difference at $.a.b" }
+        it { is_expected.to eq "There was a difference at $.a.b" }
       end
 
       context "<parent_path> with a diff in a nested Hash" do
         let(:diff) { {a: {b: Difference.new(nil, nil, "There was a difference at <parent_path>")}} }
 
-        it { is_expected.to eq "* There was a difference at $.a" }
+        it { is_expected.to eq "There was a difference at $.a" }
       end
 
       context "<path> with a diff in an Array" do
         let(:diff) { [NoDiffAtIndex.new, Difference.new(nil, nil, "There was a difference at <path>")] }
 
-        it { is_expected.to eq "* There was a difference at $[1]" }
+        it { is_expected.to eq "There was a difference at $[1]" }
       end
 
       context "<parent_path> with a diff in an Array" do
         let(:diff) { [NoDiffAtIndex.new, Difference.new(nil, nil, "There was a difference at <parent_path>")] }
 
-        it { is_expected.to eq "* There was a difference at $" }
+        it { is_expected.to eq "There was a difference at $" }
       end
 
       context "<path> with a diff in a nested Array" do
         let(:diff) { [NoDiffAtIndex.new,[NoDiffAtIndex.new, Difference.new(nil, nil, "There was a difference at <path>")]] }
 
-        it { is_expected.to eq "* There was a difference at $[1][1]" }
+        it { is_expected.to eq "There was a difference at $[1][1]" }
       end
 
       context "<parent_path> with a diff in a nested Array" do
         let(:diff) { [NoDiffAtIndex.new,[NoDiffAtIndex.new, Difference.new(nil, nil, "There was a difference at <parent_path>")]] }
 
-        it { is_expected.to eq "* There was a difference at $[1]" }
+        it { is_expected.to eq "There was a difference at $[1]" }
       end
 
       context "when there is a space in the key" do
         let(:diff) do
           {"Foo Bar" => Difference.new(nil, nil, "There was a difference at <path>")}
         end
 
-        it { is_expected.to eq "* There was a difference at $.\"Foo Bar\"" }
+        it { is_expected.to eq "There was a difference at $.\"Foo Bar\"" }
       end
 
       context "with two differences" do
@@ -70,7 +70,7 @@ module Matchers
           }
         end
 
-        it { is_expected.to eq "* There was a difference at $.a\n* There was a difference at $.b" }
+        it { is_expected.to eq "There was a difference at $.a\nThere was a difference at $.b" }
       end
 
     end