pact 1.5.0 → 1.6.0

data/CHANGELOG.md

@@ -2,6 +2,17 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+### 1.6.0 (17 February 2015)
+
+* 03a71f7 - Added specs for 'pact docs' CLI, and changed defaults to standard Pact configuration defaults (Beth Skurrie, Tue Feb 17 21:25:50 2015 +1100)
+* 8e0deba - Pact CLI docs feature basic implementation (Daniel Stankevich, Tue Feb 17 20:27:21 2015 +1100)
+* 0e0e3f2 - Added pact_specification_version to the service provider DSL. Upgraded to pact-mock_service 0.4.0 to support this option. (Beth Skurrie, Fri Feb 13 17:53:31 2015 +1100)
+* c8c58cd - minor readme updates to help with clarity :memo: (Joe Sustaric, Thu Feb 12 11:13:21 2015 +1100)
+* dda3c5e - Expose ability to add more than one doc generator (Beth Skurrie, Wed Feb 11 09:50:48 2015 +1100)
+* ada2231 - Upgrading to version 0.3.0 of pact-mock_service (Beth Skurrie, Wed Feb 4 19:41:10 2015 +1100)
+* f34c1de - Whitespace change to LICENSE.txt so I can add a comment to indicate that the previous commit to LICENSE.txt was made because Mike Rowe requested it, as he was auditing REA's use of open source software. (Beth Skurrie, Mon Feb 2 17:05:13 2015 +1100)
+* ff98558 - Update LICENSE.txt (Beth Skurrie, Mon Feb 2 16:59:14 2015 +1100)
+
 ### 1.5.0 (25 November 2014)
 
 * 9a5ab1c - Allow path to be specified as a Pact::Term (Beth, Wed Jan 21 07:56:19 2015 +1100)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 James Fraser, Sergei Matheson, Brent Snook
+Copyright (c) 2013 REA Group Ltd
 
 MIT License
 
@@ -19,4 +19,5 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/lib/pact/cli.rb

@@ -1,5 +1,5 @@
 require 'thor'
-require 'pact/cli/run_pact_verification'
+require 'pact/consumer/configuration'
 
 module Pact
   class CLI < Thor
@@ -12,8 +12,19 @@ module Pact
     method_option :provider_state, aliases: "-s", desc: "Provider state filter"
 
     def verify
+      require 'pact/cli/run_pact_verification'
       Cli::RunPactVerification.call(options)
     end
 
+    desc 'docs', "Generate Pact documentation in markdown"
+    method_option :pact_dir, desc: "Directory containing the pacts", default: Pact.configuration.pact_dir
+    method_option :doc_dir, desc: "Documentation directory", default: Pact.configuration.doc_dir
+
+    def docs
+      require 'pact/cli/generate_pact_docs'
+      require 'pact/doc/generator'
+      Pact::Doc::Generate.call(options[:pact_dir], options[:doc_dir], [Pact::Doc::Markdown::Generator])
+    end
+
   end
 end

data/lib/pact/cli/generate_pact_docs.rb

@@ -0,0 +1,4 @@
+require 'pact/doc/doc_file'
+require 'pact/doc/generate'
+require 'pact/doc/markdown/generator'
+require 'pact/consumer'

data/lib/pact/consumer.rb

@@ -3,8 +3,5 @@ require 'pact/consumer/configuration'
 require 'pact/consumer/consumer_contract_builder'
 require 'pact/consumer/consumer_contract_builders'
 require 'pact/consumer/interaction_builder'
-require 'pact/consumer/mock_service'
-require 'pact/consumer/mock_service_client'
-require 'pact/consumer/app_manager'
 require 'pact/term'
 require 'pact/something_like'

data/lib/pact/consumer/configuration/configuration_extensions.rb

@@ -38,13 +38,17 @@ module Pact
         end
 
         def doc_generator= doc_generator
+          add_doc_generator doc_generator
+        end
+
+        def add_doc_generator doc_generator
           doc_generators << begin
             if DOC_GENERATORS[doc_generator]
               DOC_GENERATORS[doc_generator]
             elsif doc_generator.respond_to?(:call)
               doc_generator
             else
-              raise "Pact.configuration.doc_generator needs to respond to call, or be in the preconfigured list: #{DOC_GENERATORS.keys}"
+              raise "doc_generator needs to respond to call, or be in the preconfigured list: #{DOC_GENERATORS.keys}"
             end
           end
         end

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

@@ -1,4 +1,4 @@
-require 'pact/consumer/app_manager'
+require 'pact/mock_service/app_manager'
 require 'pact/consumer/consumer_contract_builder'
 require 'pact/consumer/consumer_contract_builders'
 require 'pact/consumer/world'
@@ -10,7 +10,7 @@ module Pact
 
         extend Pact::DSL
 
-        attr_accessor :port, :standalone, :verify, :provider_name, :consumer_name
+        attr_accessor :port, :standalone, :verify, :provider_name, :consumer_name, :pact_specification_version
 
         def initialize name, consumer_name, provider_name
           @name = name
@@ -19,6 +19,7 @@ module Pact
           @port = nil
           @standalone = false
           @verify = true
+          @pact_specification_version = nil
         end
 
         dsl do
@@ -33,6 +34,10 @@ module Pact
           def verify verify
             self.verify = verify
           end
+
+          def pact_specification_version pact_specification_version
+            self.pact_specification_version = pact_specification_version
+          end
         end
 
         def finalize
@@ -45,7 +50,7 @@ module Pact
 
         def register_mock_service
           unless standalone
-            AppManager.instance.register_mock_service_for provider_name, "http://localhost:#{port}"
+            Pact::MockService::AppManager.instance.register_mock_service_for provider_name, "http://localhost:#{port}", mock_service_options
           end
         end
 
@@ -86,6 +91,10 @@ module Pact
         def validate
           raise "Please provide a port for service #{name}" unless port
         end
+
+        def mock_service_options
+          { pact_specification_version: pact_specification_version }
+        end
       end
     end
   end

data/lib/pact/consumer/configuration/service_consumer.rb

@@ -43,7 +43,7 @@ module Pact
 
 
         def register_consumer_app
-          Pact::Consumer::AppManager.instance.register app, port
+          Pact::MockService::AppManager.instance.register app, port
         end
       end
     end

data/lib/pact/consumer/consumer_contract_builder.rb

@@ -1,7 +1,7 @@
 require 'uri'
 require 'json/add/regexp'
 require 'pact/logging'
-require 'pact/consumer/mock_service_client'
+require 'pact/mock_service/client'
 require 'pact/consumer/interaction_builder'
 
 module Pact
@@ -21,7 +21,7 @@ module Pact
           pactfile_write_mode: attributes[:pactfile_write_mode].to_s,
           pact_dir: attributes.fetch(:pact_dir)
         }
-        @mock_service_client = MockServiceClient.new(attributes[:port])
+        @mock_service_client = Pact::MockService::Client.new(attributes[:port])
         @mock_service_base_url = "http://localhost:#{attributes[:port]}"
       end
 

data/lib/pact/consumer/spec_hooks.rb

@@ -1,20 +1,22 @@
 require 'pact/doc/generate'
 require 'pact/consumer/world'
+require 'pact/mock_service/app_manager'
+require 'pact/mock_service/client'
 
 module Pact
   module Consumer
     class SpecHooks
 
       def before_all
-        Pact::Consumer::AppManager.instance.spawn_all
+        Pact::MockService::AppManager.instance.spawn_all
         FileUtils.mkdir_p Pact.configuration.pact_dir
       end
 
       def before_each example_description
         Pact.consumer_world.register_pact_example_ran
         Pact.configuration.logger.info "Clearing all expectations"
-        Pact::Consumer::AppManager.instance.ports_of_mock_services.each do | port |
-          Pact::Consumer::MockServiceClient.clear_interactions port, example_description
+        Pact::MockService::AppManager.instance.ports_of_mock_services.each do | port |
+          Pact::MockService::Client.clear_interactions port, example_description
         end
       end
 
@@ -29,8 +31,8 @@ module Pact
         if Pact.consumer_world.any_pact_examples_ran?
           Pact.consumer_world.consumer_contract_builders.each { | c | c.write_pact }
           Pact::Doc::Generate.call
-          Pact::Consumer::AppManager.instance.kill_all
-          Pact::Consumer::AppManager.instance.clear_all
+          Pact::MockService::AppManager.instance.kill_all
+          Pact::MockService::AppManager.instance.clear_all
         end
       end
     end

data/lib/pact/doc/README.md

@@ -0,0 +1,13 @@
+# How to roll your own Doc Generator
+
+1. Create a ConsumerContractRenderer that responds to `call` and accepts a `ConsumerContract` (this is the name for the domain model of a "pact"). This should return a String. For an example, see the [Markdown::ConsumerContractRenderer][consumer_contract_renderer].
+2. Create an IndexRenderer. This allows you to create an index file for your docs. It should respond to `call` and accept the String name of the consumer, and a hash of Hash of `pact title => file_name`, and return a String. For an example, see the [Markdown::IndexRenderer][index_renderer].
+3. Create a Generator. This is responsible for the overall file generating and writing process. Copy the [Markdown::Generator][generator] and configure it with your own ConsumerContractRenderer, IndexRenderer and file details.
+
+If you would like to generate HTML documentation, see how the [HTMLPactRenderer][html_pact_renderer] in the Pact Broker does it.
+
+[consumer_contract_renderer]: https://github.com/realestate-com-au/pact/blob/master/lib/pact/doc/markdown/consumer_contract_renderer.rb
+[index_renderer]: https://github.com/realestate-com-au/pact/blob/master/lib/pact/doc/markdown/index_renderer.rb
+[generator]: https://github.com/realestate-com-au/pact/blob/master/lib/pact/doc/markdown/generator.rb
+[html_pact_renderer]: https://github.com/bethesque/pact_broker/blob/master/lib/pact_broker/api/renderers/html_pact_renderer.rb
+

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
 end

data/pact.gemspec

@@ -28,8 +28,8 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'webrick'
   gem.add_runtime_dependency 'term-ansicolor', '~> 1.0'
 
-  gem.add_runtime_dependency 'pact-support', '~> 0.2.1'
-  gem.add_runtime_dependency 'pact-mock_service', '~> 0.2.3'
+  gem.add_runtime_dependency 'pact-support', '~> 0.3.0'
+  gem.add_runtime_dependency 'pact-mock_service', '~> 0.4.0'
 
   gem.add_development_dependency 'rake', '~> 10.0.3'
   gem.add_development_dependency 'webmock', '~> 1.18.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -166,7 +166,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -174,7 +174,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: pact-mock_service
   requirement: !ruby/object:Gem::Requirement
@@ -182,7 +182,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -190,7 +190,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -338,6 +338,7 @@ files:
 - bin/pact
 - lib/pact.rb
 - lib/pact/cli.rb
+- lib/pact/cli/generate_pact_docs.rb
 - lib/pact/cli/run_pact_verification.rb
 - lib/pact/cli/spec_criteria.rb
 - lib/pact/consumer.rb
@@ -353,6 +354,7 @@ files:
 - lib/pact/consumer/rspec.rb
 - lib/pact/consumer/spec_hooks.rb
 - lib/pact/consumer/world.rb
+- lib/pact/doc/README.md
 - lib/pact/doc/doc_file.rb
 - lib/pact/doc/generate.rb
 - lib/pact/doc/generator.rb
@@ -420,7 +422,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4361813118953471608
+      hash: 1564031949540050912
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -429,7 +431,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4361813118953471608
+      hash: 1564031949540050912
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23