jazzy 0.13.7 → 0.14.0

data/lib/jazzy/themes/jony/assets/js/jazzy.js

@@ -1,3 +1,7 @@
+// Jazzy - https://github.com/realm/jazzy
+// Copyright Realm Inc.
+// SPDX-License-Identifier: MIT
+
 window.jazzy = {'docset': false}
 if (typeof window.dash != 'undefined') {
   document.documentElement.className += ' dash'

data/lib/jazzy/themes/jony/templates/doc.mustache

@@ -73,11 +73,11 @@
                   {{{return}}}
                 </div>
               {{/return}}
-              {{#github_token_url}}
+              {{#source_host_item_url}}
                 <div class="slightly-smaller">
-                  <a href="{{{github_token_url}}}">Show on GitHub</a>
+                  <a href="{{{.}}}">Show on {{source_host_name}}</a>
                 </div>
-              {{/github_token_url}}
+              {{/source_host_item_url}}
             </section>
             {{> tasks}}
           </section>

data/lib/jazzy/themes/jony/templates/footer.mustache

@@ -1,4 +1,4 @@
 <section id="footer">
   {{{copyright}}}
-  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
 </section>

data/lib/jazzy/themes/jony/templates/header.mustache

@@ -5,14 +5,14 @@
       <span class="no-mobile">{{#doc_coverage}} ({{doc_coverage}}% documented){{/doc_coverage}}</span>
     </p>
 
-    {{#github_url}}
+    {{#source_host_url}}
     <p class="header-right">
-      <a href="{{github_url}}">
-        <img src="{{path_to_root}}img/gh.png"/>
-        <span class="no-mobile">View on GitHub</span>
+      <a href="{{.}}">
+        <img src="{{path_to_root}}img/{{source_host_image}}"/>
+        <span class="no-mobile">View on {{source_host_name}}</span>
       </a>
     </p>
-    {{/github_url}}
+    {{/source_host_url}}
 
     {{#dash_url}}
     <p class="header-right">

data/lib/jazzy/themes/jony/templates/task.mustache

@@ -91,11 +91,11 @@
             {{{return}}}
           </div>
           {{/return}}
-          {{#github_token_url}}
+          {{#source_host_item_url}}
           <div class="slightly-smaller">
-            <a href="{{{github_token_url}}}">Show on GitHub</a>
+            <a href="{{{.}}}">Show on {{source_host_name}}</a>
           </div>
-          {{/github_token_url}}
+          {{/source_host_item_url}}
         </section>
         {{/direct_link}}
       </div>

data/spec/integration_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 # ------------------------------------ #
 #  Jazzy Integration tests             #
@@ -39,7 +40,7 @@
 
 # @return [Pathname] The root of the repo.
 #
-ROOT = Pathname.new(File.expand_path('../../', __FILE__)) unless defined? ROOT
+ROOT = Pathname.new(File.expand_path('..', __dir__)) unless defined? ROOT
 $:.unshift((ROOT + 'spec').to_s)
 
 require 'rubygems'
@@ -98,15 +99,15 @@ describe_cli 'jazzy' do
   subject do |s|
     s.executable = "ruby #{ROOT + 'bin/jazzy'}"
     s.environment_vars = {
-      'JAZZY_FAKE_DATE'            => 'YYYY-MM-DD',
-      'JAZZY_FAKE_VERSION'         => 'X.X.X',
+      'JAZZY_FAKE_DATE' => 'YYYY-MM-DD',
+      'JAZZY_FAKE_VERSION' => 'X.X.X',
       'COCOAPODS_SKIP_UPDATE_MESSAGE' => 'TRUE',
       'JAZZY_INTEGRATION_SPECS' => 'TRUE',
       'JAZZY_FAKE_MODULE_VERSION' => 'Y.Y.Y',
     }
     s.default_args = []
     s.replace_path ROOT.to_s, 'ROOT'
-    s.replace_pattern /^[\d\s:.-]+ ruby\[\d+:\d+\] warning:.*$[\n]?/, ''
+    s.replace_pattern /^[\d\s:.-]+ ruby\[\d+:\d+\] warning:.*$\n?/, ''
     # Remove version numbers from CocoaPods dependencies
     # to make specs resilient against dependecy updates.
     s.replace_pattern(/(Installing \w+ )\((.*)\)/, '\1(X.Y.Z)')
@@ -148,19 +149,19 @@ describe_cli 'jazzy' do
       end
       behaves_like cli_spec 'document_realm_objc',
                             '--objc ' \
-                            '--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/v#{realm_version} " \
-                            '--module Realm ' \
-                            "--module-version #{realm_version} " \
-                            '--root-url https://realm.io/docs/objc/' \
-                            "#{realm_version}/api/ " \
-                            '--umbrella-header Realm/Realm.h ' \
-                            '--framework-root . ' \
-                            "--head #{realm_head.shellescape}"
+                              '--author Realm ' \
+                              '--author_url "https://realm.io" ' \
+                              '--source-host-url ' \
+                              'https://github.com/realm/realm-cocoa ' \
+                              '--source-host-files-url https://github.com/realm/' \
+                              "realm-cocoa/tree/v#{realm_version} " \
+                              '--module Realm ' \
+                              "--module-version #{realm_version} " \
+                              '--root-url https://realm.io/docs/objc/' \
+                              "#{realm_version}/api/ " \
+                              '--umbrella-header Realm/Realm.h ' \
+                              '--framework-root . ' \
+                              "--head #{realm_head.shellescape}"
     end
 
     describe 'Creates docs for ObjC-Swift project with a variety of contents' do
@@ -169,17 +170,17 @@ describe_cli 'jazzy' do
         sourcekitten = ROOT + 'bin/sourcekitten'
         sdk = `xcrun --show-sdk-path --sdk iphonesimulator`.chomp
         objc_args = "#{base}/MiscJazzyObjCFeatures/MiscJazzyObjCFeatures.h " \
-                    '-- -x objective-c ' \
-                    "-isysroot #{sdk} " \
-                    "-I #{base} " \
-                    '-fmodules'
+          '-- -x objective-c ' \
+          "-isysroot #{sdk} " \
+          "-I #{base} " \
+          '-fmodules'
         `#{sourcekitten} doc --objc #{objc_args} > objc.json`
         `#{sourcekitten} doc -- clean build > swift.json`
       end
 
       behaves_like cli_spec 'misc_jazzy_objc_features',
                             '--theme fullwidth '\
-                            '-s objc.json,swift.json'
+                              '-s objc.json,swift.json'
     end
   end if !spec_subset || spec_subset == 'objc'
 
@@ -199,18 +200,18 @@ describe_cli 'jazzy' do
       end
       behaves_like cli_spec 'document_realm_swift',
                             '--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/v#{realm_version} " \
-                            '--module RealmSwift ' \
-                            "--module-version #{realm_version} " \
-                            '--root-url https://realm.io/docs/swift/' \
-                            "#{realm_version}/api/ " \
-                            '--xcodebuild-arguments ' \
-                            '-scheme,RealmSwift,SWIFT_VERSION=4.2 ' \
-                            "--head #{realm_head.shellescape}"
+                              '--author_url "https://realm.io" ' \
+                              '--source-host-url ' \
+                              'https://github.com/realm/realm-cocoa ' \
+                              '--source-host-files-url https://github.com/realm/' \
+                              "realm-cocoa/tree/v#{realm_version} " \
+                              '--module RealmSwift ' \
+                              "--module-version #{realm_version} " \
+                              '--root-url https://realm.io/docs/swift/' \
+                              "#{realm_version}/api/ " \
+                              '--xcodebuild-arguments ' \
+                              '-scheme,RealmSwift,SWIFT_VERSION=4.2 ' \
+                              "--head #{realm_head.shellescape}"
     end
 
     describe 'Creates Siesta docs' do
@@ -218,7 +219,7 @@ describe_cli 'jazzy' do
       # Use the default Swift version rather than the specified 4.0
       behaves_like cli_spec 'document_siesta',
                             '--output api-docs ' \
-                            '--swift-version= '
+                              '--swift-version= '
     end
 
     describe 'Creates docs for Swift project with a variety of contents' do
@@ -233,7 +234,7 @@ describe_cli 'jazzy' do
       module_path = `swift build --build-path #{build_path} --show-bin-path`
       behaves_like cli_spec 'misc_jazzy_symgraph_features',
                             '--swift-build-tool symbolgraph ' \
-                            "--build-tool-arguments -I=#{module_path} "
+                              "--build-tool-arguments -I,#{module_path} "
     end
   end if !spec_subset || spec_subset == 'swift'
 
@@ -244,4 +245,6 @@ describe_cli 'jazzy' do
                             '--podspec=Moya.podspec'
     end
   end if !spec_subset || spec_subset == 'cocoapods'
+
+  # rubocop:enable Style/MultilineIfModifier
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler/setup'
 require 'bacon'
@@ -5,7 +7,7 @@ require 'mocha-on-bacon'
 require 'pretty_bacon'
 require 'pathname'
 
-ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+ROOT = Pathname.new(File.expand_path('..', __dir__))
 $LOAD_PATH.unshift((ROOT + 'lib').to_s)
 $LOAD_PATH.unshift((ROOT + 'spec').to_s)
 

data/spec/spec_helper/pre_flight.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Restores the config to the default state before each requirement
 
 module Bacon

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.13.7
+  version: 0.14.0
 platform: ruby
 authors:
 - JP Simard
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-06 00:00:00.000000000 Z
+date: 2021-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -45,16 +45,16 @@ dependencies:
   name: open4
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +69,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
@@ -137,14 +151,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +212,9 @@ files:
 - lib/jazzy/docset_builder/info_plist.mustache
 - lib/jazzy/documentation_generator.rb
 - lib/jazzy/executable.rb
+- lib/jazzy/extensions/bitbucket/img/bitbucket.svg
+- lib/jazzy/extensions/github/img/gh.png
+- lib/jazzy/extensions/gitlab/img/gitlab.svg
 - lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.ttf
 - lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff
 - lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff2
@@ -269,6 +286,7 @@ files:
 - lib/jazzy/source_declaration/access_control_level.rb
 - lib/jazzy/source_declaration/type.rb
 - lib/jazzy/source_document.rb
+- lib/jazzy/source_host.rb
 - lib/jazzy/source_mark.rb
 - lib/jazzy/source_module.rb
 - lib/jazzy/sourcekitten.rb
@@ -284,7 +302,6 @@ files:
 - lib/jazzy/themes/apple/assets/css/jazzy.css.scss
 - lib/jazzy/themes/apple/assets/img/carat.png
 - lib/jazzy/themes/apple/assets/img/dash.png
-- lib/jazzy/themes/apple/assets/img/gh.png
 - lib/jazzy/themes/apple/assets/img/spinner.gif
 - lib/jazzy/themes/apple/assets/js/jazzy.js
 - lib/jazzy/themes/apple/assets/js/jazzy.search.js
@@ -303,7 +320,6 @@ files:
 - lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss
 - lib/jazzy/themes/fullwidth/assets/img/carat.png
 - lib/jazzy/themes/fullwidth/assets/img/dash.png
-- lib/jazzy/themes/fullwidth/assets/img/gh.png
 - lib/jazzy/themes/fullwidth/assets/img/spinner.gif
 - lib/jazzy/themes/fullwidth/assets/js/jazzy.js
 - lib/jazzy/themes/fullwidth/assets/js/jazzy.search.js
@@ -322,7 +338,6 @@ files:
 - lib/jazzy/themes/jony/assets/css/jazzy.css.scss
 - lib/jazzy/themes/jony/assets/img/carat.png
 - lib/jazzy/themes/jony/assets/img/dash.png
-- lib/jazzy/themes/jony/assets/img/gh.png
 - lib/jazzy/themes/jony/assets/js/jazzy.js
 - lib/jazzy/themes/jony/assets/js/jquery.min.js
 - lib/jazzy/themes/jony/templates/deprecation.mustache
@@ -334,7 +349,6 @@ files:
 - lib/jazzy/themes/jony/templates/task.mustache
 - lib/jazzy/themes/jony/templates/tasks.mustache
 - spec/integration_spec.rb
-- spec/sourcekitten_spec.rb
 - spec/spec_helper.rb
 - spec/spec_helper/pre_flight.rb
 homepage: https://github.com/realm/jazzy
@@ -349,7 +363,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.6.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/spec/sourcekitten_spec.rb

@@ -1,6 +0,0 @@
-require File.expand_path('../spec_helper', __FILE__)
-
-module Jazzy
-  describe SourceKitten do
-  end
-end