Merge pull request #888 from realm/jp-xcode9

Improve Xcode 9 / Swift 4 support

CHANGELOG.md

@@ -28,6 +28,9 @@
   [#789](https://github.com/realm/jazzy/issues/789)
   [#805](https://github.com/realm/jazzy/issues/805)
 
+* Fix Swift 4 declarations containing ampersands (`&`) being truncated.  
+  [JP Simard](https://github.com/jpsim)
+
 ## 0.8.3
 
 ##### Breaking

circle.yml

@@ -1,6 +1,6 @@
 machine:
   xcode:
-    version: "8.3.2"
+    version: "9.0"
 
 checkout:
   post:

lib/jazzy/podspec_documenter.rb

@@ -2,6 +2,7 @@
 require 'json'
 
 module Jazzy
+  # rubocop:disable Metrics/ClassLength
   class PodspecDocumenter
     attr_reader :podspec
 
@@ -14,7 +15,8 @@ def initialize(podspec)
     def sourcekitten_output(config)
       installation_root = Pathname(Dir.mktmpdir(['jazzy', podspec.name]))
       installation_root.rmtree if installation_root.exist?
-      Pod::Config.instance.with_changes(installation_root: installation_root) do
+      Pod::Config.instance.with_changes(installation_root: installation_root,
+                                        verbose: false) do
         sandbox = Pod::Sandbox.new(Pod::Config.instance.sandbox_root)
         installer = Pod::Installer.new(sandbox, podfile)
         installer.install!
@@ -25,7 +27,7 @@ def sourcekitten_output(config)
 
           targets.map do |t|
             args = %W[doc --module-name #{podspec.module_name} -- -target #{t}]
-            swift_version = (config.swift_version || '3')[0] + '.0'
+            swift_version = (config.swift_version || '4')[0] + '.0'
             args << "SWIFT_VERSION=\"#{swift_version}\""
             SourceKitten.run_sourcekitten(args)
           end
@@ -117,8 +119,12 @@ def podfile
           ss.available_platforms.each do |p|
             # Travis builds take too long when building docs for all available
             # platforms for the Moya integration spec, so we just document OSX.
+            # Also Moya's RxSwift subspec doesn't yet support Swift 4, so skip
+            # that too while we're at it.
             # TODO: remove once jazzy is fast enough.
-            next if ENV['JAZZY_INTEGRATION_SPECS'] && p.name != :osx
+            if ENV['JAZZY_INTEGRATION_SPECS']
+              next if (p.name != :osx) || (ss.name == 'Moya/RxSwift')
+            end
             target("Jazzy-#{ss.name.gsub('/', '__')}-#{p.name}") do
               use_frameworks!
               platform p.name, p.deployment_target

spec/integration_spec.rb

@@ -208,8 +208,8 @@
       behaves_like cli_spec 'document_siesta',
                             # Siesta already has Docs/
                             '--output api-docs',
-                            # Use default Swift rather than the specified 3.0.2
-                            '--swift-version='
+                            # Use Swift 4 rather than the specified 3.0.2
+                            '--swift-version=4'
     end
 
     describe 'Creates docs for Swift project with a variety of contents' do