jazzy 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ffd1283d3e9554b3129dae997e56f6e3a7772e1
-  data.tar.gz: 8f3bc13009bdf3c7f2ddc8d71809b33507eaceb4
+  metadata.gz: 5ca696c264b7d1fb8815ad306c4d00a38b590762
+  data.tar.gz: ae530a97b56831e98b9ddd84b5cc5d48f927f86e
 SHA512:
-  metadata.gz: 0c0f29323eba5d303f45a48ae40e9191907e72b6df3cbd8890960571b3914bd2b31f3cfed623bc5d4cbec258601e197fdc241850026026062b5695ca75c8c04c
-  data.tar.gz: 1c104f4b91a35bede65f55e596f93f3317fef2cda6e6eb842b0b55f2ef1eb60a2ca8fa353267f817e6ddbbf589ec0d8666c1e84eb17c6b3068de0e9fd430b8eb
+  metadata.gz: 7f8be594e771a90d3a82e353c0ba070d927a09ebd566466d0677ed09ba50c728411812aea9a58be0abe8494efea3ee0490a2f227f7bf88c36c854a037db237a9
+  data.tar.gz: c8fd9cd72d6aeb4de45c35992af945fb85cf5940d32461da6d63af0ba64e0d63e39cf4c7fb7dbb27dadaffb77d8c80811b6f1a3de49ace84ba6a428c14cbbf6c

data/.rubocop.yml

@@ -25,6 +25,12 @@ Metrics/AbcSize:
 Metrics/ModuleLength:
   Enabled: false
 
+Metrics/BlockLength:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
 # We adopted raise instead of fail.
 SignalException:
   EnforcedStyle: only_raise

data/CHANGELOG.md

@@ -1,3 +1,75 @@
+## 0.7.4
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Generate shields.io badge for documentation coverage, unless
+  `hide_documentation_coverage` is set.  
+  [Harlan Haskins](https://github.com/harlanhaskins)
+  [#723](https://github.com/realm/jazzy/issues/723)
+
+* Add support for searching docs when using the `fullwidth` theme. A new option,
+  `--disable-search`, lets you turn this off.  
+  [Esad Hajdarevic](https://github.com/esad)
+  [Tom MacWright](https://github.com/tmcw)
+  [Nadia Barbosa](https://github.com/captainbarbosa)
+  [#14](https://github.com/realm/jazzy/issues/14)
+
+* New config option `use_safe_filenames` encodes unsafe characters when
+  generating filenames. By default, documentation may receive filenames like
+  `/(_:_:).html`. With `use_safe_filenames`, the same file will receive the name
+  `_2F_28_5F_3A_5F_3A_29.html` instead.  
+  [Jeremy David Giesbrecht](https://github.com/SDGGiesbrecht)
+  [#699](https://github.com/realm/jazzy/issues/699)
+  [#146](https://github.com/realm/jazzy/issues/146)
+  [#361](https://github.com/realm/jazzy/issues/361)
+  [#547](https://github.com/realm/jazzy/issues/547)
+
+* References to Objective-C methods are now autolinked.  
+  [Minh Nguyễn](https://github.com/1ec5)
+  [#362](https://github.com/realm/jazzy/issues/362)
+
+* Print documentation coverage percentage and the number of undocumented
+  methods to the command line when running jazzy.  
+  [Jason Wray](https://github.com/friedbunny)
+
+##### Bug Fixes
+
+* Fix issue where existing abstracts for non custom sections would be completely
+  overwritten when using extra abstract injection with --abstract.  
+  [Thibaud Robelain](https://github.com/thibaudrobelain)
+  [#600](https://github.com/realm/jazzy/issues/600)
+
+* Fix issue where generic type parameters registered as undocumented symbols.  
+  [Jeremy David Giesbrecht](https://github.com/SDGGiesbrecht)
+  [#429](https://github.com/realm/jazzy/issues/429)
+
+* Fix issue where parameter and return callouts were duplicated in documentation.  
+  [Jeremy David Giesbrecht](https://github.com/SDGGiesbrecht)
+  [#673](https://github.com/realm/jazzy/issues/673)
+
+* Fix issue where Objective-C superclass in declaration was unlinked.  
+  [Minh Nguyễn](https://github.com/1ec5)
+  [#706](https://github.com/realm/jazzy/issues/706)
+
+* Fix issue where multiple Objective-C categories of the same external class
+  in different files were merged into one and named after the first category
+  found.  
+  [Minh Nguyễn](https://github.com/1ec5)
+  [#539](https://github.com/realm/jazzy/issues/539)
+
+* String literals in code listings are no longer wrapped in `<q>` tags (`apple`
+  and `fullwidth` themes only).  
+  [Minh Nguyễn](https://github.com/1ec5)
+  [#714](https://github.com/realm/jazzy/issues/714)
+
+* Fix issue where passing a `--podspec` argument would use a malformed
+  `SWIFT_VERSION` value, causing compilation to fail.  
+  [JP Simard](https://github.com/jpsim)
+
 ## 0.7.3
 
 ##### Breaking

data/CONTRIBUTING.md

@@ -35,7 +35,7 @@ git checkout master
 git pull
 git checkout -
 git rebase master
-bundle install
+rake bootstrap
 bundle exec rake rebuild_integration_fixtures
 cd spec/integration_specs
 git checkout -b $jazzy_branch_name
@@ -49,6 +49,8 @@ git push
 You'll need push access to the integration specs repo to do this. You can
 request access from one of the maintainers when filing your PR.
 
+You must have Xcode 8.2 installed to build the integration specs.
+
 ## Making changes to SourceKitten
 
 When changes are landed in the https://github.com/jpsim/SourceKitten repo the

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.7.3)
+    jazzy (0.7.4)
       cocoapods (~> 1.0)
       mustache (~> 0.99)
       open4
@@ -14,7 +14,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    CFPropertyList (2.3.4)
+    CFPropertyList (2.3.5)
     activesupport (4.2.7.1)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
@@ -23,7 +23,7 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.5.0)
       public_suffix (~> 2.0, >= 2.0.2)
-    ast (2.2.0)
+    ast (2.3.0)
     bacon (1.2.0)
     claide (1.0.1)
     claide-plugins (0.9.2)
@@ -33,35 +33,36 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.1.1)
+    cocoapods (1.2.0)
       activesupport (>= 4.0.2, < 5)
       claide (>= 1.0.1, < 2.0)
-      cocoapods-core (= 1.1.1)
+      cocoapods-core (= 1.2.0)
       cocoapods-deintegrate (>= 1.0.1, < 2.0)
-      cocoapods-downloader (>= 1.1.2, < 2.0)
+      cocoapods-downloader (>= 1.1.3, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
       cocoapods-search (>= 1.0.0, < 2.0)
       cocoapods-stats (>= 1.0.0, < 2.0)
-      cocoapods-trunk (>= 1.1.1, < 2.0)
+      cocoapods-trunk (>= 1.1.2, < 2.0)
       cocoapods-try (>= 1.1.0, < 2.0)
       colored (~> 1.2)
       escape (~> 0.0.4)
       fourflusher (~> 2.0.1)
       gh_inspector (~> 1.0)
-      molinillo (~> 0.5.1)
+      molinillo (~> 0.5.5)
       nap (~> 1.0)
-      xcodeproj (>= 1.3.3, < 2.0)
-    cocoapods-core (1.1.1)
+      ruby-macho (~> 0.2.5)
+      xcodeproj (>= 1.4.1, < 2.0)
+    cocoapods-core (1.2.0)
       activesupport (>= 4.0.2, < 5)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
     cocoapods-deintegrate (1.0.1)
-    cocoapods-downloader (1.1.2)
+    cocoapods-downloader (1.1.3)
     cocoapods-plugins (1.0.0)
       nap
     cocoapods-search (1.0.0)
     cocoapods-stats (1.0.0)
-    cocoapods-trunk (1.1.1)
+    cocoapods-trunk (1.1.2)
       nap (>= 0.8, < 2.0)
       netrc (= 0.7.8)
     cocoapods-try (1.1.0)
@@ -89,20 +90,20 @@ GEM
       faraday (~> 0.8)
     fourflusher (2.0.1)
     fuzzy_match (2.0.4)
-    gh_inspector (1.0.2)
+    gh_inspector (1.0.3)
     git (1.3.0)
     hashdiff (0.3.0)
-    i18n (0.7.0)
-    json (1.8.3)
+    i18n (0.8.0)
+    json (1.8.6)
     kramdown (1.13.1)
     liferaft (0.0.6)
     metaclass (0.0.4)
-    minitest (5.10.0)
+    minitest (5.10.1)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.2)
       mocha (>= 0.13.0)
-    molinillo (0.5.4)
+    molinillo (0.5.6)
     multipart-post (2.0.0)
     mustache (0.99.8)
     nanaimo (0.2.3)
@@ -111,46 +112,47 @@ GEM
     octokit (4.6.2)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parser (2.3.0.7)
+    parser (2.3.3.1)
       ast (~> 2.2)
     powerpack (0.1.1)
     prettybacon (0.0.2)
       bacon (~> 1.2)
     public_suffix (2.0.4)
-    rainbow (2.1.0)
+    rainbow (2.2.1)
     rake (10.5.0)
-    redcarpet (3.3.4)
+    redcarpet (3.4.0)
     rouge (1.11.1)
-    rubocop (0.39.0)
-      parser (>= 2.3.0.7, < 3.0)
+    rubocop (0.47.1)
+      parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.7.5)
+    ruby-macho (0.2.6)
+    ruby-progressbar (1.8.1)
     safe_yaml (1.0.4)
-    sass (3.4.22)
+    sass (3.4.23)
     sawyer (0.8.1)
       addressable (>= 2.3.5, < 2.6)
       faraday (~> 0.8, < 1.0)
-    sqlite3 (1.3.12)
+    sqlite3 (1.3.13)
     terminal-table (1.6.0)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    unicode-display_width (1.0.3)
+    unicode-display_width (1.1.3)
     webmock (1.24.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.4.1)
+    xcodeproj (1.4.2)
       CFPropertyList (~> 2.3.3)
       activesupport (>= 3)
       claide (>= 1.0.1, < 2.0)
       colored (~> 1.2)
-      nanaimo (~> 0.2.0)
+      nanaimo (~> 0.2.3)
 
 PLATFORMS
   ruby
@@ -170,4 +172,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.13.6
+   1.14.3

data/README.md

@@ -2,7 +2,7 @@
 
 ![analytics](https://ga-beacon.appspot.com/UA-50247013-2/jazzy/README?pixel)
 
-[![Build Status](https://travis-ci.org/realm/jazzy.svg?branch=master)](https://travis-ci.org/realm/jazzy)
+[![Build Status](https://circleci.com/gh/realm/jazzy.svg?style=svg)](https://circleci.com/gh/realm/jazzy)
 
 *jazzy is a command-line utility that generates documentation for Swift or Objective-C*
 
@@ -25,8 +25,9 @@ unacceptable behavior to [info@realm.io](mailto:info@realm.io).
 
 ## Requirements
 
-* A version of [Xcode][xcode] (6.x or 7.x) capable of building the project
-you wish to document. It must be installed in a location indexed by Spotlight.
+* A version of [Xcode][xcode] capable of building the project you wish to
+document. It must be installed in a location indexed by Spotlight for the
+`--swift-version` configuration option to succeed.
 
 ## Installation
 
@@ -49,7 +50,8 @@ all available options, run `jazzy --help config`.
 ### Supported keywords
 
 Swift header documentation is written in markdown and supports a number of special keywords.
-For a complete list and examples, see Erica Sadun's post on [*Swift header documentation in Xcode 7*](http://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/).
+For a complete list and examples, see Erica Sadun's post on [*Swift header documentation in Xcode 7*](http://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/)
+and her [book on Swift Documentation Markup](https://itunes.apple.com/us/book/swift-documentation-markup/id1049010423).
 
 For Objective-C documentation the same keywords are supported, but note that the format
 is slightly different. In Swift you would write `- returns:`, but in Objective-C you write `@return`. See Apple's [*HeaderDoc User Guide*](https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/tags/tags.html) for more details. **Note: `jazzy` currently does not support _all_ Objective-C keywords listed in this document.**
@@ -99,14 +101,13 @@ jazzy \
   --author Realm \
   --author_url https://realm.io \
   --github_url https://github.com/realm/realm-cocoa \
-  --github-file-prefix https://github.com/realm/realm-cocoa/tree/v0.96.2 \
-  --module-version 0.96.2 \
-  --umbrella-header Realm/Realm.h \
-  --framework-root . \
+  --github-file-prefix https://github.com/realm/realm-cocoa/tree/v2.2.0 \
+  --module-version 2.2.0 \
+  --xcodebuild-arguments --objc,Realm/Realm.h,--,-x,objective-c,-isysroot,$(xcrun --show-sdk-path),-I,$(pwd) \
   --module Realm \
-  --root-url https://realm.io/docs/objc/0.96.2/api/ \
+  --root-url https://realm.io/docs/objc/2.2.0/api/ \
   --output docs/objc_output \
-  --theme docs/themes
+  --head "$(cat docs/custom_head.html)"
 ```
 
 This is how the AFNetworking docs are generated:

data/circle.yml

@@ -0,0 +1,12 @@
+machine:
+  xcode:
+    version: "8.2"
+
+checkout:
+  post:
+    - git submodule update --init --recursive
+
+test:
+  override:
+    - bundle exec rake spec
+    - bundle exec danger --verbose || true

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Resources

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current/Resources

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/SourceKittenFramework

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current/SourceKittenFrame

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Commandant

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.f

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Resources

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.f

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/Current

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.f

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Resources

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.frame

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Result

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.frame

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/Current

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.frame

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Resources

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.fr

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.fr

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/Current

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.fr

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Resources

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framewo

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/Current

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framewo

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Yams

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framewo

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A

data/lib/jazzy/config.rb

@@ -246,6 +246,11 @@ module Jazzy
                    'https://github.com/realm/realm-cocoa/tree/v0.87.1)'
 
     # ──────── Doc generation options ────────
+    config_attr :disable_search,
+      command_line: '--disable-search',
+      description: ['Avoid generating a search index. '\
+                    'Search is available in some themes.'],
+      default: false
 
     config_attr :skip_documentation,
       command_line: '--skip-documentation',
@@ -294,6 +299,14 @@ module Jazzy
         Pathname(__FILE__).parent + 'themes' + t
       end
 
+    config_attr :use_safe_filenames,
+      command_line: '--use-safe-filenames',
+      description: 'Replace unsafe characters in filenames with an encoded '\
+                   'representation. This will reduce human readability of '\
+                   'some URLs, but may be necessary for projects that '\
+                   'expose filename-unfriendly functions such as /(_:_:)',
+      default: false
+
     config_attr :template_directory,
       command_line: ['-t', '--template-directory DIRPATH'],
       description: 'DEPRECATED: Use --theme instead.',
@@ -331,7 +344,8 @@ module Jazzy
       if config.root_url
         config.dash_url ||= URI.join(
           config.root_url,
-          "docsets/#{config.module_name}.xml")
+          "docsets/#{config.module_name}.xml",
+        )
       end
 
       config
@@ -414,7 +428,7 @@ module Jazzy
     def read_config_file(file)
       case File.extname(file)
         when '.json'         then JSON.parse(File.read(file))
-        when '.yaml', '.yml' then YAML.load(File.read(file))
+        when '.yaml', '.yml' then YAML.safe_load(File.read(file))
         else raise "Config file must be .yaml or .json, but got #{file.inspect}"
       end
     end

data/lib/jazzy/doc_builder.rb

@@ -1,6 +1,7 @@
 require 'fileutils'
 require 'mustache'
 require 'uri'
+require 'net/http'
 require 'pathname'
 require 'sass'
 
@@ -8,6 +9,7 @@ require 'jazzy/config'
 require 'jazzy/doc'
 require 'jazzy/docset_builder'
 require 'jazzy/documentation_generator'
+require 'jazzy/search_builder'
 require 'jazzy/jazzy_markdown'
 require 'jazzy/podspec_documenter'
 require 'jazzy/readme_generator'
@@ -112,22 +114,24 @@ module Jazzy
 
       structure = doc_structure_for_docs(docs)
 
-      docs << SourceDocument.new.tap do |sd|
-        sd.name = 'index'
-        sd.children = []
-        sd.type = SourceDeclaration::Type.new 'document.markdown'
-        sd.readme_path = options.readme_path
-      end
+      docs << SourceDocument.make_index(options.readme_path)
 
       source_module = SourceModule.new(options, docs, structure, coverage)
 
       output_dir = options.output
       build_docs(output_dir, source_module.docs, source_module)
 
+      unless options.disable_search
+        warn 'building search index'
+        SearchBuilder.build(source_module, output_dir)
+      end
+
       copy_assets(output_dir)
 
       DocsetBuilder.new(output_dir, source_module).build!
 
+      download_badge(source_module.doc_coverage, options)
+
       friendly_path = relative_path_if_inside(output_dir, Pathname.pwd)
       puts "jam out ♪♫ to your fresh new docs in `#{friendly_path}`"
 
@@ -143,11 +147,16 @@ module Jazzy
         sourcekitten_output,
         options.min_acl,
         options.skip_undocumented,
-        DocumentationGenerator.source_docs)
+        DocumentationGenerator.source_docs,
+      )
 
       prepare_output_dir(options.output, options.clean)
       write_lint_report(undocumented, options)
 
+      puts "#{coverage}\% documentation coverage " \
+        "with #{undocumented.count} undocumented symbol" \
+        "#{undocumented.count == 1 ? '' : 's'}"
+
       unless options.skip_documentation
         build_site(docs, coverage, options)
       end
@@ -212,6 +221,7 @@ module Jazzy
       doc[:name] = name
       doc[:overview] = Jazzy.markdown.render(doc_model.content(source_module))
       doc[:custom_head] = Config.instance.custom_head
+      doc[:disable_search] = Config.instance.disable_search
       doc[:doc_coverage] = source_module.doc_coverage unless
         Config.instance.hide_documentation_coverage
       doc[:structure] = source_module.doc_structure
@@ -224,6 +234,44 @@ module Jazzy
       doc.render
     end
 
+    # Returns the appropriate color for the provided percentage,
+    # used for generating a badge on shields.io
+    # @param [Number] coverage The documentation coverage percentage
+    def self.color_for_coverage(coverage)
+      if coverage < 10
+        'red'
+      elsif coverage < 30
+        'orange'
+      elsif coverage < 60
+        'yellow'
+      elsif coverage < 85
+        'yellowgreen'
+      elsif coverage < 90
+        'green'
+      else
+        'brightgreen'
+      end
+    end
+
+    # Downloads an SVG from shields.io displaying the documentation percentage
+    # @param [Number] coverage The documentation coverage percentage
+    # @param [Config] options Build options
+    def self.download_badge(coverage, options)
+      if options.hide_documentation_coverage
+        return
+      end
+      warn 'downloading coverage badge'
+      color = color_for_coverage(coverage)
+      uri = URI.parse('https://img.shields.io')
+      url_path = "/badge/documentation-#{coverage}%25-#{color}.svg"
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        resp = http.get url_path
+        File.open(options.output + 'badge.svg', 'wb') do |file|
+          file.write resp.body
+        end
+      end
+    end
+
     def self.should_link_to_github(file)
       return unless file
       file = file.realpath.to_path
@@ -243,7 +291,8 @@ module Jazzy
                   "#L#{item.line}"
                 end
       relative_file_path = item.file.realpath.relative_path_from(
-        source_module.root_path)
+        source_module.root_path,
+      )
       "#{github_prefix}/#{relative_file_path}#{gh_line}"
     end
 
@@ -306,6 +355,7 @@ module Jazzy
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     # Build Mustache document from single parsed doc
     # @param [Config] options Build options
     # @param [Hash] doc_model Parsed doc. @see SourceKitten.parse
@@ -319,6 +369,7 @@ module Jazzy
 
       doc = Doc.new # Mustache model instance
       doc[:custom_head] = Config.instance.custom_head
+      doc[:disable_search] = Config.instance.disable_search
       doc[:doc_coverage] = source_module.doc_coverage unless
         Config.instance.hide_documentation_coverage
       doc[:name] = doc_model.name
@@ -335,5 +386,6 @@ module Jazzy
       doc[:path_to_root] = path_to_root
       doc.render.gsub(ELIDED_AUTOLINK_TOKEN, path_to_root)
     end
+    # rubocop:enable Metrics/MethodLength
   end
 end