pact 1.1.0.rc2 → 1.1.0.rc3

data/lib/pact/consumer/mock_service/verification_get.rb

@@ -24,27 +24,46 @@ module Pact
       def respond env
         if interaction_list.all_matched?
           logger.info "Verifying - interactions matched for example \"#{example_description(env)}\""
-          [200, {}, ['Interactions matched']]
+          [200, {'Content-Type' => 'text/plain'}, ['Interactions matched']]
         else
 
-          missing_interactions_summaries = interaction_list.missing_interactions_summaries
-          interaction_mismatches_summaries = interaction_list.interaction_mismatches_summaries
-          unexpected_requests_summaries = interaction_list.unexpected_requests_summaries
-          error_message = "Missing requests:
-  #{missing_interactions_summaries.join("\n  ")}
-Incorrect requests:
-  #{interaction_mismatches_summaries.join("\n  ")}
-Unexpected requests:
-  #{unexpected_requests_summaries.join("\n  ")}"
-logger.warn "Verifying - actual interactions do not match expected interactions for example \"#{example_description(env)}\". \n#{error_message}"
-logger.warn error_message
-          [500, {}, ["Actual interactions do not match expected interactions for mock #{name}.\n#{error_message}\nSee #{log_description} for details."]]
+          error_message = FailureMessage.new(interaction_list).to_s
+          logger.warn "Verifying - actual interactions do not match expected interactions for example \"#{example_description(env)}\". \n#{error_message}"
+          logger.warn error_message
+          [500, {'Content-Type' => 'text/plain'}, ["Actual interactions do not match expected interactions for mock #{name}.\n\n#{error_message}See #{log_description} for details."]]
         end
       end
 
       def example_description env
         params_hash(env)['example_description']
       end
+
+      class FailureMessage
+
+        def initialize interaction_list
+          @interaction_list = interaction_list
+        end
+
+        def to_s
+          titles_and_summaries.collect do | title, summaries |
+            "#{title}:\n\t#{summaries.join("\n\t")}\n\n" if summaries.any?
+          end.compact.join
+
+        end
+
+        private
+
+        attr_reader :interaction_list
+
+        def titles_and_summaries
+          {
+            "Incorrect requests" => interaction_list.interaction_mismatches_summaries,
+            "Missing requests" => interaction_list.missing_interactions_summaries,
+            "Unexpected requests" => interaction_list.unexpected_requests_summaries,
+          }
+        end
+
+      end
     end
   end
 end

data/lib/pact/consumer/rspec.rb

@@ -1,6 +1,5 @@
 require 'pact/consumer'
 require 'pact/consumer/spec_hooks'
-require 'pact/consumer/rspec/full_example_description'
 
 module Pact
   module Consumer
@@ -12,7 +11,6 @@ end
 
 hooks = Pact::Consumer::SpecHooks.new
 
-
 RSpec.configure do |config|
   config.include Pact::Consumer::RSpec, :pact => true
 
@@ -21,11 +19,11 @@ RSpec.configure do |config|
   end
 
   config.before :each, :pact => true do | example |
-    hooks.before_each Pact::Consumer::RSpec::FullExampleDescription.new(example).to_s
+    hooks.before_each example.example.full_description
   end
 
   config.after :each, :pact => true do | example |
-    hooks.after_each Pact::Consumer::RSpec::FullExampleDescription.new(example).to_s
+    hooks.after_each example.example.full_description
   end
 
   config.after :suite do

data/lib/pact/consumer/spec_hooks.rb

@@ -1,3 +1,5 @@
+require 'pact/doc/generate'
+
 module Pact
   module Consumer
     class SpecHooks
@@ -22,7 +24,7 @@ module Pact
       end
 
       def after_suite
-        Pact.configuration.logger.info "After suite"
+        Pact::Doc::Generate.call
         Pact::Consumer::AppManager.instance.kill_all
         Pact::Consumer::AppManager.instance.clear_all
       end

data/lib/pact/consumer_contract/consumer_contract.rb

@@ -3,6 +3,7 @@ require 'pact/something_like'
 require 'pact/symbolize_keys'
 require 'pact/term'
 require 'pact/version'
+require 'pact/shared/active_support_support'
 require 'date'
 require 'json/add/regexp'
 require 'open-uri'
@@ -10,7 +11,6 @@ require_relative 'service_consumer'
 require_relative 'service_provider'
 require_relative 'interaction'
 require_relative 'request'
-require_relative 'active_support_support'
 require_relative 'pact_file'
 require_relative 'file_name'
 

data/lib/pact/consumer_contract/interaction.rb

@@ -1,6 +1,6 @@
 require 'pact/consumer_contract/request'
 require 'pact/symbolize_keys'
-require 'pact/consumer_contract/active_support_support'
+require 'pact/shared/active_support_support'
 
 module Pact
    class Interaction

data/lib/pact/doc/doc_file.rb

@@ -0,0 +1,40 @@
+module Pact
+  module Doc
+
+    class DocFile
+
+      def initialize consumer_contract, dir, interactions_renderer, file_extension
+        @dir = dir
+        @consumer_contract = consumer_contract
+        @interactions_renderer = interactions_renderer
+        @file_extension = file_extension
+      end
+
+      def write
+        File.open(path, "w") { |io|  io << doc_file_contents }
+      end
+
+      def title
+        consumer_contract.provider.name
+      end
+
+      def name
+        "#{consumer_contract.consumer.name} - #{consumer_contract.provider.name}#{file_extension}"
+      end
+
+      private
+
+      attr_reader :dir, :consumer_contract, :interactions_renderer, :file_extension
+
+
+      def path
+        File.join(dir, name)
+      end
+
+      def doc_file_contents
+        interactions_renderer.call(consumer_contract)
+      end
+
+    end
+  end
+end

data/lib/pact/doc/generate.rb

@@ -0,0 +1,11 @@
+module Pact
+  module Doc
+    class Generate
+
+      def self.call pact_dir  = Pact.configuration.pact_dir, doc_dir = Pact.configuration.doc_dir, doc_generators = Pact.configuration.doc_generators
+        doc_generators.each{| doc_generator| doc_generator.call pact_dir, doc_dir }
+      end
+
+    end
+  end
+end

data/lib/pact/doc/generator.rb

@@ -0,0 +1,81 @@
+require 'pact/doc/doc_file'
+require 'fileutils'
+
+module Pact
+  module Doc
+
+    class Generator
+
+      def initialize pact_dir, doc_dir, options
+        @doc_dir = doc_dir
+        @pact_dir = pact_dir
+        @interactions_renderer = options[:interactions_renderer]
+        @doc_type = options[:doc_type]
+        @file_extension = options[:file_extension]
+        @index_renderer = options[:index_renderer]
+        @index_name = options[:index_name]
+        @after = options.fetch(:after, lambda{|pact_dir, target_dir, consumer_contracts| })
+      end
+
+      def call
+        ensure_target_dir_exists
+        write_index if consumer_contracts.any?
+        write_doc_files
+        perform_after_hook
+      end
+
+      private
+
+      attr_reader :doc_dir, :pact_dir, :interactions_renderer, :doc_type, :file_extension, :index_renderer, :after
+
+      def write_index
+        File.open(index_file_path, "w") { |io|  io << index_file_contents }
+      end
+
+      def index_file_path
+        File.join(target_dir, "#{@index_name}#{file_extension}")
+      end
+
+      def index_file_contents
+        index_renderer.call(consumer_contracts.first.consumer.name, index_data)
+      end
+
+      def index_data
+        doc_files.each_with_object({}) do | doc_file, data |
+          data[doc_file.title] = doc_file.name
+        end
+      end
+
+      def write_doc_files
+        doc_files.each(&:write)
+      end
+
+      def doc_files
+        consumer_contracts.collect do | consumer_contract |
+          DocFile.new(consumer_contract, target_dir, interactions_renderer, file_extension)
+        end
+      end
+
+      def consumer_contracts
+        @consumer_contracts ||= begin
+          Dir.glob("#{pact_dir}/**").collect do |file|
+            Pact::ConsumerContract.from_uri file
+          end
+        end
+      end
+
+      def perform_after_hook
+        after.call(pact_dir, target_dir, consumer_contracts)
+      end
+
+      def ensure_target_dir_exists
+        FileUtils.mkdir_p target_dir
+      end
+
+      def target_dir
+        File.join(doc_dir, doc_type)
+      end
+
+    end
+  end
+end

data/lib/pact/doc/interaction_view_model.rb

@@ -0,0 +1,113 @@
+require 'pact/shared/active_support_support'
+
+module Pact
+  module Doc
+    class InteractionViewModel
+
+      include Pact::ActiveSupportSupport
+
+      def initialize interaction, consumer_contract
+        @interaction = interaction
+        @consumer_contract = consumer_contract
+      end
+
+      def id
+        @id ||= begin
+          if has_provider_state?
+            "#{description} given #{interaction.provider_state}"
+          else
+            interaction.description
+          end.gsub(/\s+/,'_')
+        end
+      end
+
+      def request_method
+        interaction.request.method.upcase
+      end
+
+      def request_path
+        interaction.request.path
+      end
+
+      def response_status
+        interaction.response['status']
+      end
+
+      def consumer_name
+        @consumer_contract.consumer.name
+      end
+
+      def provider_name
+        @consumer_contract.provider.name
+      end
+
+      def has_provider_state?
+        @interaction.provider_state && !@interaction.provider_state.empty?
+      end
+
+      def provider_state start_of_sentence = false
+        apply_capitals(@interaction.provider_state.strip, start_of_sentence)
+      end
+
+      def description start_of_sentence = false
+        apply_capitals(@interaction.description.strip, start_of_sentence)
+      end
+
+      def request
+        fix_json_formatting JSON.pretty_generate(clean_request)
+      end
+
+      def response
+        fix_json_formatting JSON.pretty_generate(clean_response)
+      end
+
+      private
+
+      attr_reader :interaction, :consumer_contract
+
+      def clean_request
+        ordered_clean_hash Reification.from_term(interaction.request).to_hash
+      end
+
+      def clean_response
+        ordered_clean_hash Reification.from_term(interaction.response)
+      end
+
+      # Remove empty body and headers hashes from response, and empty headers from request,
+      # as an empty hash means "allow anything" - it's more intuitive and cleaner to just
+      # remove the empty hashes from display.
+      def ordered_clean_hash source
+        ordered_keys.each_with_object({}) do |key, target|
+          if source.key? key
+            target[key] = source[key] unless value_is_an_empty_hash_that_is_not_request_body(source[key], key)
+          end
+        end
+      end
+
+      def value_is_an_empty_hash_that_is_not_request_body value, key
+        value.is_a?(Hash) && value.empty? && key != :body
+      end
+
+      def ordered_keys
+        [:method, :path, :query, :headers, :body, "status", "headers","body"]
+      end
+
+      def remove_key_if_empty key, hash
+        hash.delete(key) if hash[key].is_a?(Hash) && hash[key].empty?
+      end
+
+      def apply_capitals string, start_of_sentence = false
+        start_of_sentence ? capitalize_first_letter(string) : lowercase_first_letter(string)
+      end
+
+      def capitalize_first_letter string
+        string[0].upcase + string[1..-1]
+      end
+
+      def lowercase_first_letter string
+        string[0].downcase + string[1..-1]
+      end
+
+    end
+  end
+end

data/lib/pact/doc/markdown/generator.rb

@@ -0,0 +1,26 @@
+require 'pact/doc/generator'
+require 'pact/doc/markdown/interactions_renderer'
+require 'pact/doc/markdown/index_renderer'
+
+module Pact
+  module Doc
+    module Markdown
+      class Generator < Pact::Doc::Generator
+
+        def initialize pact_dir, doc_dir
+          super(pact_dir, doc_dir,
+            interactions_renderer: InteractionsRenderer,
+            doc_type: 'markdown',
+            file_extension: '.md',
+            index_renderer: IndexRenderer,
+            index_name: 'README')
+        end
+
+        def self.call pact_dir, doc_dir
+          new(pact_dir, doc_dir).call
+        end
+
+      end
+    end
+  end
+end

data/lib/pact/doc/markdown/index_renderer.rb

@@ -0,0 +1,41 @@
+module Pact
+  module Doc
+    module Markdown
+      class IndexRenderer
+
+        attr_reader :consumer_name
+        attr_reader :docs # Hash of pact title => file_name
+
+        def initialize consumer_name, docs
+          @consumer_name = consumer_name
+          @docs = docs
+        end
+
+        def self.call consumer_name, docs
+          new(consumer_name, docs).call
+        end
+
+        def call
+          title + "\n\n" + table_of_contents + "\n"
+        end
+
+        private
+
+        def table_of_contents
+          docs.collect do | title, file_name |
+            item title, file_name
+          end.join("\n")
+        end
+
+        def title
+          "### Pacts for #{consumer_name}"
+        end
+
+        def item title, file_name
+          "* [#{title}](#{file_name})"
+        end
+
+      end
+    end
+  end
+end