jazzy 0.13.5 → 0.14.1

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 > swift.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'
 
@@ -187,9 +188,10 @@ describe_cli 'jazzy' do
     describe 'Creates docs with a module name, author name, project URL, ' \
       'xcodebuild options, and github info' do
       behaves_like cli_spec 'document_alamofire',
-                            '--skip-undocumented',
-                            # Ignore existing docs output
-                            '--clean'
+                            '--skip-undocumented ' \
+                              '--clean ' \
+                              '--xcodebuild-arguments ' \
+                              "-destination,'platform=OS X'"
     end
 
     describe 'Creates Realm Swift docs' do
@@ -199,32 +201,42 @@ 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,' \
+                              "-destination,'platform=OS X' " \
+                              "--head #{realm_head.shellescape}"
     end
 
     describe 'Creates Siesta docs' do
+      # Siesta already has Docs/
+      # Use the default Swift version rather than the specified 4.0
       behaves_like cli_spec 'document_siesta',
-                            # Siesta already has Docs/
-                            '--output api-docs',
-                            # Use the default Swift version rather than the
-                            # specified 4.0
-                            '--swift-version='
+                            '--output api-docs ' \
+                              '--swift-version= '
     end
 
     describe 'Creates docs for Swift project with a variety of contents' do
-      behaves_like cli_spec 'misc_jazzy_features',
-                            '-b -Xswiftc,-swift-version,-Xswiftc,4.2'
+      behaves_like cli_spec 'misc_jazzy_features'
+    end
+
+    describe 'Creates docs for Swift project from a .swiftmodule' do
+      build_path = Dir.getwd + 'tmp/.build'
+      package_path =
+        ROOT + 'spec/integration_specs/misc_jazzy_symgraph_features/before'
+      `swift build --package-path #{package_path} --build-path #{build_path}`
+      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} "
     end
   end if !spec_subset || spec_subset == 'swift'
 
@@ -235,4 +247,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/pre_flight.rb

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

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)
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.13.5
+  version: 0.14.1
 platform: ruby
 authors:
 - JP Simard
 - Tim Anglade
 - Samuel Giddins
 - John Fairhurst
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2021-10-02 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
@@ -168,7 +182,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/Tests.yml"
 - ".gitignore"
 - ".gitmodules"
 - ".rubocop.yml"
@@ -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,15 +286,22 @@ 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
 - lib/jazzy/stats.rb
+- lib/jazzy/symbol_graph.rb
+- lib/jazzy/symbol_graph/constraint.rb
+- lib/jazzy/symbol_graph/ext_node.rb
+- lib/jazzy/symbol_graph/graph.rb
+- lib/jazzy/symbol_graph/relationship.rb
+- lib/jazzy/symbol_graph/sym_node.rb
+- lib/jazzy/symbol_graph/symbol.rb
 - lib/jazzy/themes/apple/assets/css/highlight.css.scss
 - 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
@@ -296,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
@@ -315,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
@@ -327,14 +349,13 @@ 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
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -342,16 +363,15 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Soulful docs for Swift & Objective-C.
 test_files: []

data/.circleci/config.yml

@@ -1,83 +0,0 @@
-aliases:
-  - &save-mac-bundler-cache
-    key: bundle_mac
-    paths:
-      - vendor/bundle
-
-  - &restore-mac-bundler-cache
-    key: bundle_mac
-
-  - &bundler-environment
-    BUNDLE_JOBS: 3
-    BUNDLE_RETRY: 3
-    BUNDLE_PATH: vendor/bundle
-
-version: 2
-jobs:
-
-  swift:
-    macos:
-      xcode: "11.4.0"
-    environment: *bundler-environment
-    steps:
-      - checkout
-      - restore_cache: *restore-mac-bundler-cache
-      - run: bundle install
-      - run: git submodule update --init --recursive
-      - run: bundle exec rake swift_spec
-      - save_cache: *save-mac-bundler-cache
-
-  objc:
-    macos:
-      xcode: "11.4.0"
-    environment: *bundler-environment
-    steps:
-      - checkout
-      - restore_cache: *restore-mac-bundler-cache
-      - run: bundle install
-      - run: git submodule update --init --recursive
-      - run: bundle exec rake objc_spec
-      - save_cache: *save-mac-bundler-cache
-
-  cocoapods:
-    macos:
-      xcode: "11.4.0"
-    environment: *bundler-environment
-    steps:
-      - checkout
-      - restore_cache:
-          key: cocoapods
-      - restore_cache: *restore-mac-bundler-cache
-      - run: bundle install
-      - run: git submodule update --init --recursive
-      - run: bundle exec rake cocoapods_spec
-      - save_cache:
-          key: cocoapods
-          paths:
-            - ~/.cocoapods
-      - save_cache: *save-mac-bundler-cache
-
-  danger_and_rubocop:
-    docker:
-      - image: circleci/ruby:2.4-node
-        environment: *bundler-environment
-    steps:
-      - checkout
-      - restore_cache:
-          key: bundle_linux
-      - run: bundle install
-      - run: bundle exec danger --verbose || true
-      - run: bundle exec rake rubocop
-      - save_cache:
-          key: bundle_linux
-          paths:
-            - vendor/bundle
-
-workflows:
-  version: 2
-  workflow:
-    jobs:
-      - swift
-      - objc
-      - cocoapods
-      - danger_and_rubocop

data/spec/sourcekitten_spec.rb

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