jazzy 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6b0e2553b3b64a0b692c79a6d62735a8f2e35d3322fe371bd926f050a8b0850
-  data.tar.gz: df8dd3fb4e80e0c9e69db6ec7f0337c5c9687a90a130bc899748ab789ee56d61
+  metadata.gz: 5f55576dbfb09517321b17ea90b50e672c8ad6c50c563e087b381849ed2f7445
+  data.tar.gz: 9a5c54d86a73cf125109bd87a0f669c9807b419aa41f54174544d3ebd86632d2
 SHA512:
-  metadata.gz: b6d2956ca649999f8802d00c59fadd0b5e608a9f46a553c1b5c54cb9d49962d69336fcfe822bde691409770412bf484da4f73cf8405720dbfe24aa6096a9ca60
-  data.tar.gz: 036cb12b85c127721690e88295ac68ed5b25dee219c7c87f5933a20d4e2a285fa75acbc4496a97637f09ca07b4caee193aca783ee73ffdd110a9a02fbe064f00
+  metadata.gz: 61f70f156605dacf0b066262b7ccf694902117ce483fc056fa669af232530a7da180ed70134e1c0b8570f8ad55228c3324b53007e6f9d0519fe306977bd40b1e
+  data.tar.gz: 7655c01fd0c0bc9113b532b2e0531e56faf0aa00a5815a9713ca35b4cfa1fb45c391f6b77b4cd8501bce34ed4617c84dc1e2e436afda7bf8721d715ddb917d70

data/.github/workflows/Tests.yml

@@ -31,7 +31,7 @@ jobs:
       matrix:
         spec: ["objc_spec", "swift_spec", "cocoapods_spec"]
     env:
-      DEVELOPER_DIR: /Applications/Xcode_12.5.app/Contents/Developer
+      DEVELOPER_DIR: /Applications/Xcode_13.0.app/Contents/Developer
     steps:
       - uses: actions/checkout@v2
         with:

data/.rubocop.yml

@@ -7,7 +7,7 @@ AllCops:
   SuggestExtensions: false
   TargetRubyVersion: 2.6
 
-#- Pending Cops as of 1.19.0 ---------------------------------------------#
+#- Pending Cops as of 1.22.0 ---------------------------------------------#
 
 Gemspec/DateAssignment: # (new in 1.10)
   Enabled: true
@@ -29,6 +29,8 @@ Lint/EmptyClass: # (new in 1.3)
   Enabled: true
 Lint/EmptyInPattern: # (new in 1.16)
   Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
 Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
   Enabled: true
 Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
@@ -39,6 +41,8 @@ Lint/OrAssignmentToConstant: # (new in 1.9)
   Enabled: true
 Lint/RedundantDirGlobSort: # (new in 1.8)
   Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
 Lint/SymbolConversion: # (new in 1.9)
   Enabled: true
 Lint/ToEnumArguments: # (new in 1.1)
@@ -51,6 +55,8 @@ Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
   Enabled: true
 Naming/InclusiveLanguage: # (new in 1.18)
   Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
 Style/ArgumentsForwarding: # (new in 1.1)
   Enabled: true
 Style/CollectionCompact: # (new in 1.2)
@@ -73,12 +79,18 @@ Style/NegatedIfElseCondition: # (new in 1.2)
   Enabled: true
 Style/NilLambda: # (new in 1.3)
   Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
 Style/QuotedSymbols: # (new in 1.16)
   Enabled: true
 Style/RedundantArgument: # (new in 1.4)
   Enabled: true
 Style/RedundantSelfAssignmentBranch: # (new in 1.19)
   Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
 Style/StringChars: # (new in 1.12)
   Enabled: true
 Style/SwapValues: # (new in 1.1)
@@ -195,6 +207,10 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Max: 10
 
+# Too much firing on basic arithmetic
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
 #- Jazzy specs -----------------------------------------------------------#
 
 # Allow for `should.match /regexp/`.

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+## 0.14.1
+
+##### Breaking
+
+* Support Swift SPI groups.  Swift declarations marked `@_spi` are no longer
+  included in docs when `--min-acl` is set to `public` or `open`.  Use
+  `--include-spi-declarations` to include docs for these declarations.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1263](https://github.com/realm/jazzy/issues/1263)
+
+##### Enhancements
+
+* Correct line number references with Xcode 13.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Support `union` declarations in Objective-C headers.  
+  [Brian Osborn](https://github.com/bosborn)
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Support Swift concurrency features: identify actors and asynchronous
+  methods.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Bug Fixes
+
+* Improve HTML5 correctness, all themes.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1280](https://github.com/realm/jazzy/issues/1280)
+
 ## 0.14.0
 
 ##### Breaking

data/CONTRIBUTING.md

@@ -49,7 +49,7 @@ 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 12.5 installed to build the integration specs.
+You must have Xcode 13 installed to build the integration specs.
 
 ## Making changes to SourceKitten
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.14.0)
+    jazzy (0.14.1)
       cocoapods (~> 1.5)
       mustache (~> 1.1)
       open4 (~> 1.3)
@@ -15,12 +15,14 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    CFPropertyList (3.0.3)
-    activesupport (5.2.6)
+    CFPropertyList (3.0.4)
+      rexml
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     algoliasearch (1.27.5)
@@ -37,10 +39,10 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.10.2)
-      addressable (~> 2.6)
+    cocoapods (1.11.2)
+      addressable (~> 2.8)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.10.2)
+      cocoapods-core (= 1.11.2)
       cocoapods-deintegrate (>= 1.0.3, < 2.0)
       cocoapods-downloader (>= 1.4.0, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -51,26 +53,26 @@ GEM
       escape (~> 0.0.4)
       fourflusher (>= 2.3.0, < 3.0)
       gh_inspector (~> 1.0)
-      molinillo (~> 0.6.6)
+      molinillo (~> 0.8.0)
       nap (~> 1.0)
-      ruby-macho (~> 1.4)
-      xcodeproj (>= 1.19.0, < 2.0)
-    cocoapods-core (1.10.2)
-      activesupport (> 5.0, < 6)
-      addressable (~> 2.6)
+      ruby-macho (>= 1.0, < 3.0)
+      xcodeproj (>= 1.21.0, < 2.0)
+    cocoapods-core (1.11.2)
+      activesupport (>= 5.0, < 7)
+      addressable (~> 2.8)
       algoliasearch (~> 1.0)
       concurrent-ruby (~> 1.1)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
       netrc (~> 0.11)
-      public_suffix
+      public_suffix (~> 4.0)
       typhoeus (~> 1.0)
-    cocoapods-deintegrate (1.0.4)
-    cocoapods-downloader (1.4.0)
+    cocoapods-deintegrate (1.0.5)
+    cocoapods-downloader (1.5.1)
     cocoapods-plugins (1.0.0)
       nap
     cocoapods-search (1.0.1)
-    cocoapods-trunk (1.5.0)
+    cocoapods-trunk (1.6.0)
       nap (>= 0.8, < 2.0)
       netrc (~> 0.11)
     cocoapods-try (1.2.0)
@@ -81,7 +83,7 @@ GEM
       colored2 (~> 3.1)
     crack (0.4.5)
       rexml
-    danger (8.3.1)
+    danger (8.4.0)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -98,7 +100,7 @@ GEM
     escape (0.0.4)
     ethon (0.14.0)
       ffi (>= 1.15.0)
-    faraday (1.7.0)
+    faraday (1.8.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -119,7 +121,7 @@ GEM
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    ffi (1.15.3)
+    ffi (1.15.4)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
@@ -139,7 +141,7 @@ GEM
     mocha (1.13.0)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
-    molinillo (0.6.6)
+    molinillo (0.8.0)
     multipart-post (2.1.1)
     mustache (1.1.1)
     nanaimo (0.3.0)
@@ -150,7 +152,7 @@ GEM
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.20.1)
+    parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     prettybacon (0.0.2)
@@ -162,19 +164,19 @@ GEM
     redcarpet (3.5.1)
     regexp_parser (2.1.1)
     rexml (3.2.5)
-    rouge (3.26.0)
-    rubocop (1.19.0)
+    rouge (3.26.1)
+    rubocop (1.22.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.10.0)
+    rubocop-ast (1.12.0)
       parser (>= 3.0.1.1)
-    ruby-macho (1.4.0)
+    ruby-macho (2.5.1)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     sassc (2.4.0)
@@ -183,14 +185,13 @@ GEM
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
     sqlite3 (1.4.2)
-    terminal-table (3.0.1)
+    terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    thread_safe (0.3.6)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
-    unicode-display_width (2.0.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
     webmock (3.14.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -204,6 +205,7 @@ GEM
       colored2 (~> 3.1)
       nanaimo (~> 0.3.0)
       rexml (~> 3.2.4)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -318,6 +318,9 @@ In Swift mode, Jazzy by default documents only `public` and `open` declarations.
 include declarations with a lower access level, set the `--min-acl` flag to `internal`,
 `fileprivate`, or `private`.
 
+By default, Jazzy does not document declarations marked `@_spi` when `--min-acl` is
+set to `public` or `open`.  Set the `--include-spi-declarations` flag to include them.
+
 In Objective-C mode, Jazzy documents all declarations found in the `--umbrella-header`
 header file and any other header files included by it.
 

data/lib/jazzy/config.rb

@@ -476,6 +476,12 @@ module Jazzy
         'have children.',
       default: false
 
+    config_attr :include_spi_declarations,
+      command_line: '--[no-]include-spi-declarations',
+      description: 'Include Swift declarations marked `@_spi` even if '\
+        '--min-acl is set to `public` or `open`.',
+      default: false
+
     # rubocop:enable Layout/ArgumentAlignment
 
     def initialize

data/lib/jazzy/doc_builder.rb

@@ -183,7 +183,7 @@ module Jazzy
       decls.map do |decl|
         {
           file: decl.file,
-          line: decl.line || decl.start_line,
+          line: decl.start_line || decl.line,
           symbol: decl.fully_qualified_name,
           symbol_kind: decl.type.kind,
           warning: 'undocumented',
@@ -236,6 +236,11 @@ module Jazzy
       SourceKitten.autolink_document(html, doc_model)
     end
 
+    def self.render_inline(doc_model, markdown)
+      html = Markdown.render_inline(markdown)
+      SourceKitten.autolink_document(html, doc_model)
+    end
+
     # Build Mustache document - common fields between page types
     def self.new_document(source_module, doc_model)
       Doc.new.tap do |doc|
@@ -370,6 +375,8 @@ module Jazzy
         deprecation_message: item.deprecation_message,
         unavailable_message: item.unavailable_message,
         usage_discouraged: item.usage_discouraged?,
+        async: item.async,
+        declaration_note: item.declaration_note,
       }
     end
     # rubocop:enable Metrics/MethodLength
@@ -377,7 +384,7 @@ module Jazzy
     def self.make_task(mark, uid, items, doc_model)
       {
         name: mark.name,
-        name_html: (render(doc_model, mark.name) if mark.name),
+        name_html: (render_inline(doc_model, mark.name) if mark.name),
         uid: ERB::Util.url_encode(uid),
         items: items,
         pre_separator: mark.has_start_dash,

data/lib/jazzy/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jazzy
-  VERSION = '0.14.0' unless defined? Jazzy::VERSION
+  VERSION = '0.14.1' unless defined? Jazzy::VERSION
 end

data/lib/jazzy/highlighter.rb

@@ -2,6 +2,18 @@
 
 require 'rouge'
 
+# While Rouge is downlevel (Rouge PR#1715 unreleased)
+module Rouge
+  module Lexers
+    class Swift
+      prepend :root do
+        rule(/\b(?:async|await|isolated)\b/, Keyword)
+        rule(/\b(?:actor|nonisolated)\b/, Keyword::Declaration)
+      end
+    end
+  end
+end
+
 module Jazzy
   # This module helps highlight code
   module Highlighter

data/lib/jazzy/jazzy_markdown.rb

@@ -40,7 +40,8 @@ module Jazzy
         mapped = map_footnote(num)
         "\n<li><div class='footnote-def' id=\"fn#{mapped}\">" +
           text.sub(%r{(?=</p>)},
-                   "&nbsp;<a href=\"#fnref#{mapped}\">&#8617;</a></div></li>")
+                   "&nbsp;<a href=\"#fnref#{mapped}\">&#8617;</a>") +
+          '</div></li>'
       end
     end
 
@@ -66,7 +67,9 @@ module Jazzy
       def codespan(text)
         case text
         when /^\$\$(.*)\$\$$/m
-          o = ["<div class='math m-block'>", Regexp.last_match[1], '</div>']
+          o = ["</p><div class='math m-block'>",
+               Regexp.last_match[1],
+               '</div><p>']
           Markdown.has_math = true
         when /^\$(.*)\$$/m
           o = ["<span class='math m-inline'>", Regexp.last_match[1], '</span>']
@@ -258,12 +261,19 @@ module Jazzy
       @markdown ||= Redcarpet::Markdown.new(renderer, REDCARPET_OPTIONS)
     end
 
+    # Produces <p>-delimited block content
     def self.render(markdown_text, default_language = nil)
       renderer.reset
       renderer.default_language = default_language
       markdown.render(markdown_text)
     end
 
+    # Produces <span>-delimited inline content
+    def self.render_inline(markdown_text, default_language = nil)
+      render(markdown_text, default_language)
+        .sub(%r{^<p>(.*)</p>$}, '<span>\1</span>')
+    end
+
     def self.rendered_returns
       renderer.returns
     end
@@ -275,7 +285,7 @@ module Jazzy
     class JazzyCopyright < Redcarpet::Render::HTML
       def link(link, _title, content)
         %(<a class="link" href="#{link}" target="_blank" \
-rel="noopener" rel="external">#{content}</a>)
+rel="external noopener">#{content}</a>)
       end
     end
 

data/lib/jazzy/source_declaration/type.rb

@@ -12,11 +12,24 @@ module Jazzy
 
       attr_reader :kind
 
-      def initialize(kind)
+      def initialize(kind, declaration = nil)
+        kind = fixup_kind(kind, declaration) if declaration
         @kind = kind
         @type = TYPES[kind]
       end
 
+      # Improve kind from full declaration
+      def fixup_kind(kind, declaration)
+        if kind == 'source.lang.swift.decl.class' &&
+           declaration.include?(
+             '<syntaxtype.keyword>actor</syntaxtype.keyword>',
+           )
+          'source.lang.swift.decl.actor'
+        else
+          kind
+        end
+      end
+
       def dash_type
         @type && @type[:dash]
       end
@@ -115,7 +128,8 @@ module Jazzy
       end
 
       def swift_extensible?
-        kind =~ /^source\.lang\.swift\.decl\.(class|struct|protocol|enum)$/
+        kind =~
+          /^source\.lang\.swift\.decl\.(class|struct|protocol|enum|actor)$/
       end
 
       def swift_protocol?
@@ -255,6 +269,11 @@ module Jazzy
           dash: 'Struct',
           global: true,
         }.freeze,
+        'sourcekitten.source.lang.objc.decl.union' => {
+          jazzy: 'Union',
+          dash: 'Union',
+          global: true,
+        }.freeze,
         'sourcekitten.source.lang.objc.decl.field' => {
           jazzy: 'Field',
           dash: 'Field',
@@ -269,6 +288,11 @@ module Jazzy
         }.freeze,
 
         # Swift
+        'source.lang.swift.decl.actor' => {
+          jazzy: 'Actor',
+          dash: 'Actor',
+          global: true,
+        }.freeze,
         'source.lang.swift.decl.function.accessor.address' => {
           jazzy: 'Addressor',
           dash: 'Function',

data/lib/jazzy/source_declaration.rb

@@ -138,6 +138,7 @@ module Jazzy
     attr_accessor :unavailable_message
     attr_accessor :generic_requirements
     attr_accessor :inherited_types
+    attr_accessor :async
 
     def usage_discouraged?
       unavailable || deprecated
@@ -188,6 +189,14 @@ module Jazzy
         (swift? && usr && modulename.nil?)
     end
 
+    # Info text for contents page by collapsed item name
+    def declaration_note
+      notes = [default_impl_abstract ? 'default implementation' : nil,
+               from_protocol_extension ? 'extension method' : nil,
+               async ? 'asynchronous' : nil].compact
+      notes.join(', ').humanize unless notes.empty?
+    end
+
     def alternative_abstract
       if file = alternative_abstract_file
         Pathname(file).read

data/lib/jazzy/sourcekitten.rb

@@ -277,12 +277,18 @@ module Jazzy
       declaration.children = []
     end
 
+    def self.attribute?(doc, attr_name)
+      doc['key.attributes']&.find do |attribute|
+        attribute['key.attribute'] == "source.decl.attribute.#{attr_name}"
+      end
+    end
+
     def self.availability_attribute?(doc)
-      return false unless doc['key.attributes']
+      attribute?(doc, 'available')
+    end
 
-      !doc['key.attributes'].select do |attribute|
-        attribute.values.first == 'source.decl.attribute.available'
-      end.empty?
+    def self.spi_attribute?(doc)
+      attribute?(doc, '_spi')
     end
 
     def self.should_document?(doc)
@@ -302,10 +308,31 @@ module Jazzy
         return false
       end
 
-      # Document enum elements, since we can't tell their ACL.
+      # Only document @_spi declarations in some scenarios
+      return false unless should_document_spi?(doc)
+
+      # Don't document declarations excluded by the min_acl setting
+      if type.swift_extension?
+        should_document_swift_extension?(doc)
+      else
+        should_document_acl?(type, doc)
+      end
+    end
+
+    # Check visibility: SPI
+    def self.should_document_spi?(doc)
+      spi_ok = @min_acl < SourceDeclaration::AccessControlLevel.public ||
+               Config.instance.include_spi_declarations ||
+               (!spi_attribute?(doc) && !doc['key.symgraph_spi'])
+
+      @stats.add_spi_skipped unless spi_ok
+      spi_ok
+    end
+
+    # Check visibility: access control
+    def self.should_document_acl?(type, doc)
+      # Include all enum elements for now, can't tell their ACL.
       return true if type.swift_enum_element?
-      # Document extensions if they might have parts covered by the ACL.
-      return should_document_swift_extension?(doc) if type.swift_extension?
 
       acl_ok = SourceDeclaration::AccessControlLevel.from_doc(doc) >= @min_acl
       unless acl_ok
@@ -315,6 +342,8 @@ module Jazzy
       acl_ok
     end
 
+    # Document extensions if they add protocol conformances, or have any
+    # member that needs to be documented.
     def self.should_document_swift_extension?(doc)
       doc['key.inheritedtypes'] ||
         Array(doc['key.substructure']).any? do |subdoc|
@@ -495,6 +524,14 @@ module Jazzy
         .join("\n")
     end
 
+    # Exclude non-async routines that accept async closures
+    def self.swift_async?(fully_annotated_decl)
+      document = REXML::Document.new(fully_annotated_decl)
+      !document.elements['/*/syntaxtype.keyword[text()="async"]'].nil?
+    rescue StandardError
+      nil
+    end
+
     # Strip default property attributes because libclang
     # adds them all, even if absent in the original source code.
     DEFAULT_ATTRIBUTES = %w[atomic readwrite assign unsafe_unretained].freeze
@@ -536,7 +573,9 @@ module Jazzy
         end
         declaration = SourceDeclaration.new
         declaration.parent_in_code = parent
-        declaration.type = SourceDeclaration::Type.new(doc['key.kind'])
+        declaration.type =
+          SourceDeclaration::Type.new(doc['key.kind'],
+                                      doc['key.fully_annotated_decl'])
         declaration.typename = doc['key.typename']
         declaration.objc_name = doc['key.name']
         documented_name = if Config.instance.hide_objc? && doc['key.swift_name']
@@ -581,6 +620,11 @@ module Jazzy
         inherited_types = doc['key.inheritedtypes'] || []
         declaration.inherited_types =
           inherited_types.map { |type| type['key.name'] }.compact
+        declaration.async =
+          doc['key.symgraph_async'] ||
+          if xml_declaration = doc['key.fully_annotated_decl']
+            swift_async?(xml_declaration)
+          end
 
         next unless make_doc_info(doc, declaration)
 
@@ -790,7 +834,9 @@ module Jazzy
       extensions.each do |ext|
         ext.children = ext.children.select do |ext_member|
           proto_member = protocol.children.find do |p|
-            p.name == ext_member.name && p.type == ext_member.type
+            p.name == ext_member.name &&
+              p.type == ext_member.type &&
+              p.async == ext_member.async
           end
 
           # Extension-only method, keep.

data/lib/jazzy/stats.rb

@@ -5,7 +5,7 @@ module Jazzy
   class Stats
     include Config::Mixin
 
-    attr_reader :documented, :acl_skipped, :undocumented_decls
+    attr_reader :documented, :acl_skipped, :spi_skipped, :undocumented_decls
 
     def add_documented
       @documented += 1
@@ -15,6 +15,10 @@ module Jazzy
       @acl_skipped += 1
     end
 
+    def add_spi_skipped
+      @spi_skipped += 1
+    end
+
     def add_undocumented(decl)
       @undocumented_decls << decl
     end
@@ -32,7 +36,7 @@ module Jazzy
     end
 
     def initialize
-      @documented = @acl_skipped = 0
+      @documented = @acl_skipped = @spi_skipped = 0
       @undocumented_decls = []
     end
 
@@ -54,6 +58,11 @@ module Jazzy
           "#{symbol_or_symbols(acl_skipped)} " \
           '(use `--min-acl` to specify a different minimum ACL)'
       end
+
+      if spi_skipped > 0
+        puts "skipped #{spi_skipped} SPI #{symbol_or_symbols(spi_skipped)} " \
+          '(use `--include-spi-declarations` to include these)'
+      end
     end
 
     def doc_coverage

data/lib/jazzy/symbol_graph/graph.rb

@@ -78,8 +78,13 @@ module Jazzy
 
       # Protocol conformance is redundant if it's unconditional
       # and already expressed in the type's declaration.
+      #
+      # Skip implementation-detail conformances.
       def redundant_conformance?(rel, type, protocol)
-        type && rel.constraints.empty? && type.conformance?(protocol)
+        return false unless type
+
+        (rel.constraints.empty? && type.conformance?(protocol)) ||
+          (type.actor? && rel.actor_protocol?)
       end
 
       # source is a member/protocol requirement of target

data/lib/jazzy/symbol_graph/relationship.rb

@@ -22,6 +22,12 @@ module Jazzy
         kind == :defaultImplementationOf
       end
 
+      # Protocol conformances added by compiler to actor decls that
+      # users aren't interested in.
+      def actor_protocol?
+        %w[Actor Sendable].include?(target_fallback)
+      end
+
       def initialize(hash)
         kind = hash[:kind]
         unless KINDS.include?(kind)

data/lib/jazzy/symbol_graph/sym_node.rb

@@ -25,6 +25,7 @@ module Jazzy
 
     # A SymNode is a node of the reconstructed syntax tree holding a symbol.
     # It can turn itself into SourceKit and helps decode extensions.
+    # rubocop:disable Metrics/ClassLength
     class SymNode < BaseNode
       attr_accessor :symbol
       attr_writer :override
@@ -61,6 +62,10 @@ module Jazzy
         symbol.kind.end_with?('protocol')
       end
 
+      def actor?
+        symbol.kind.end_with?('actor')
+      end
+
       def constraints
         symbol.constraints
       end
@@ -112,8 +117,13 @@ module Jazzy
         " : #{superclass_name}"
       end
 
+      # approximately...
+      def async?
+        symbol.declaration =~ /\basync\b[^)]*$/
+      end
+
       def full_declaration
-        symbol.availability
+        symbol.attributes
           .append(symbol.declaration + inherits_clause + where_clause)
           .join("\n")
       end
@@ -130,6 +140,7 @@ module Jazzy
           'key.accessibility' => symbol.acl,
           'key.parsed_decl' => declaration,
           'key.annotated_decl' => xml_declaration,
+          'key.symgraph_async' => async?,
         }
         if docs = symbol.doc_comments
           hash['key.doc.comment'] = docs
@@ -147,6 +158,7 @@ module Jazzy
         unless children.empty?
           hash['key.substructure'] = children_to_sourcekit
         end
+        hash['key.symgraph_spi'] = true if symbol.spi
 
         hash
       end
@@ -159,5 +171,6 @@ module Jazzy
         symbol <=> other.symbol
       end
     end
+    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/jazzy/symbol_graph/symbol.rb

@@ -10,10 +10,11 @@ module Jazzy
       attr_accessor :declaration
       attr_accessor :kind
       attr_accessor :acl
+      attr_accessor :spi
       attr_accessor :location # can be nil, keys :filename :line :character
       attr_accessor :constraints # array, can be empty
       attr_accessor :doc_comments # can be nil
-      attr_accessor :availability # array, can be empty
+      attr_accessor :attributes # array, can be empty
       attr_accessor :generic_type_params # set, can be empty
       attr_accessor :parameter_names # array, can be nil
 
@@ -24,13 +25,14 @@ module Jazzy
       def initialize(hash)
         self.usr = hash[:identifier][:precise]
         self.path_components = hash[:pathComponents]
-        raw_decl = hash[:declarationFragments].map { |f| f[:spelling] }.join
-        init_kind(hash[:kind][:identifier])
+        raw_decl, keywords = parse_decl_fragments(hash[:declarationFragments])
+        init_kind(hash[:kind][:identifier], keywords)
         init_declaration(raw_decl)
         if func_signature = hash[:functionSignature]
           init_func_signature(func_signature)
         end
         init_acl(hash[:accessLevel])
+        self.spi = hash[:spi]
         if location = hash[:location]
           init_location(location)
         end
@@ -38,10 +40,20 @@ module Jazzy
         if comments_hash = hash[:docComment]
           init_doc_comments(comments_hash)
         end
-        init_availability(hash[:availability] || [])
+        init_attributes(hash[:availability] || [])
         init_generic_type_params(hash)
       end
 
+      def parse_decl_fragments(fragments)
+        decl = ''
+        keywords = Set.new
+        fragments.each do |frag|
+          decl += frag[:spelling]
+          keywords.add(frag[:spelling]) if frag[:kind] == 'keyword'
+        end
+        [decl, keywords]
+      end
+
       # Repair problems with SymbolGraph's declprinter
 
       def init_declaration(raw_decl)
@@ -87,17 +99,22 @@ module Jazzy
         'static.subscript' => 'function.subscript',
         'typealias' => 'typealias',
         'associatedtype' => 'associatedtype',
+        'actor' => 'actor',
       }.freeze
 
       # We treat 'static var' differently to 'class var'
-      def adjust_kind_for_declaration(kind)
-        return kind unless declaration =~ /\bstatic\b/
+      # We treat actors as first-class entities
+      def adjust_kind_for_declaration(kind, keywords)
+        if kind == 'swift.class' && keywords.member?('actor')
+          return 'swift.actor'
+        end
+        return kind unless keywords.member?('static')
 
         kind.gsub(/type/, 'static')
       end
 
-      def init_kind(kind)
-        adjusted = adjust_kind_for_declaration(kind)
+      def init_kind(kind, keywords)
+        adjusted = adjust_kind_for_declaration(kind, keywords)
         sourcekit_kind = KIND_MAP[adjusted.sub('swift.', '')]
         raise "Unknown symbol kind '#{kind}'" unless sourcekit_kind
 
@@ -159,8 +176,8 @@ module Jazzy
       # Availability
       # Re-encode this as Swift.  Should really teach Jazzy about these,
       # could maybe then do something smarter here.
-      def init_availability(avail_hash_list)
-        self.availability = avail_hash_list.map do |avail|
+      def availability_attributes(avail_hash_list)
+        avail_hash_list.map do |avail|
           str = '@available('
           if avail[:isUnconditionallyDeprecated]
             str += '*, deprecated'
@@ -190,6 +207,15 @@ module Jazzy
         str
       end
 
+      def spi_attributes
+        spi ? ['@_spi(Unknown)'] : []
+      end
+
+      def init_attributes(avail_hash_list)
+        self.attributes =
+          availability_attributes(avail_hash_list) + spi_attributes
+      end
+
       # Sort order
       include Comparable
 

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

@@ -29,7 +29,7 @@
     <div class="content-wrapper">
       <p id="breadcrumbs">
         <a href="{{path_to_root}}index.html">{{module_name}} Reference</a>
-        <img id="carat" src="{{path_to_root}}img/carat.png" />
+        <img id="carat" src="{{path_to_root}}img/carat.png" alt=""/>
         {{name}} {{kind}} Reference
       </p>
     </div>
@@ -85,5 +85,4 @@
       </article>
     </div>
   </body>
-</div>
 </html>

data/lib/jazzy/themes/apple/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="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>
+  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
 </section>

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

@@ -2,17 +2,17 @@
   <div class="content-wrapper">
     <p><a href="{{path_to_root}}index.html">{{docs_title}}</a>{{#doc_coverage}} ({{doc_coverage}}% documented){{/doc_coverage}}</p>
     {{#source_host_url}}
-    <p class="header-right"><a href="{{.}}"><img src="{{path_to_root}}img/{{source_host_image}}"/>View on {{source_host_name}}</a></p>
+    <p class="header-right"><a href="{{.}}"><img src="{{path_to_root}}img/{{source_host_image}}" alt="{{source_host_name}}"/>View on {{source_host_name}}</a></p>
     {{/source_host_url}}
     {{#dash_url}}
-    <p class="header-right"><a href="{{dash_url}}"><img src="{{path_to_root}}img/dash.png"/>Install in Dash</a></p>
+    <p class="header-right"><a href="{{dash_url}}"><img src="{{path_to_root}}img/dash.png" alt="Dash"/>Install in Dash</a></p>
     {{/dash_url}}
     {{^disable_search}}
-    <p class="header-right">
+    <div class="header-right">
       <form role="search" action="{{path_to_root}}search.json">
         <input type="text" placeholder="Search documentation" data-typeahead>
       </form>
-    </p>
+    </div>
     {{/disable_search}}
   </div>
 </header>

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

@@ -28,16 +28,11 @@
         <a class="token discouraged" href="#/{{usr}}">{{{name_html}}}</a>
         {{/usage_discouraged}}
         </code>
-        {{#default_impl_abstract}}
+        {{#declaration_note}}
           <span class="declaration-note">
-            Default implementation
+            {{.}}
           </span>
-        {{/default_impl_abstract}}
-        {{#from_protocol_extension}}
-          <span class="declaration-note">
-            Extension method
-          </span>
-        {{/from_protocol_extension}}
+        {{/declaration_note}}
       </div>
       <div class="height-container">
         <div class="pointer-container"></div>

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

@@ -32,7 +32,7 @@
 
     <p class="breadcrumbs">
       <a class="breadcrumb" href="{{path_to_root}}index.html">{{module_name}} Reference</a>
-      <img class="carat" src="{{path_to_root}}img/carat.png" />
+      <img class="carat" src="{{path_to_root}}img/carat.png" alt=""/>
       {{name}} {{kind}} Reference
     </p>
 
@@ -91,5 +91,4 @@
     </div>
     {{> footer}}
   </body>
-</div>
 </html>

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

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

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

@@ -7,17 +7,17 @@
   </p>
 
   {{^disable_search}}
-  <p class="header-col--secondary">
+  <div class="header-col--secondary">
     <form role="search" action="{{path_to_root}}search.json">
       <input type="text" placeholder="Search documentation" data-typeahead>
     </form>
-  </p>
+  </div>
   {{/disable_search}}
 
   {{#source_host_url}}
     <p class="header-col header-col--secondary">
       <a class="header-link" href="{{.}}">
-        <img class="header-icon" src="{{path_to_root}}img/{{source_host_image}}"/>
+        <img class="header-icon" src="{{path_to_root}}img/{{source_host_image}}" alt="{{source_host_name}}"/>
         View on {{source_host_name}}
       </a>
     </p>
@@ -26,7 +26,7 @@
   {{#dash_url}}
     <p class="header-col header-col--secondary">
       <a class="header-link" href="{{dash_url}}">
-        <img class="header-icon" src="{{path_to_root}}img/dash.png"/>
+        <img class="header-icon" src="{{path_to_root}}img/dash.png" alt="Dash"/>
         Install in Dash
       </a>
     </p>

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

@@ -28,16 +28,11 @@
         <a class="token discouraged" href="#/{{usr}}">{{{name_html}}}</a>
         {{/usage_discouraged}}
         </code>
-        {{#default_impl_abstract}}
+        {{#declaration_note}}
           <span class="declaration-note">
-            Default implementation
+            {{.}}
           </span>
-        {{/default_impl_abstract}}
-        {{#from_protocol_extension}}
-          <span class="declaration-note">
-            Extension method
-          </span>
-        {{/from_protocol_extension}}
+        {{/declaration_note}}
       </div>
       <div class="height-container">
         <div class="pointer-container"></div>

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

@@ -27,7 +27,7 @@
         <p id="breadcrumbs">
           <span class="no-mobile">
             <a href="{{path_to_root}}index.html">{{module_name}} Reference</a>
-            <img id="carat" src="{{path_to_root}}img/carat.png" />
+            <img id="carat" src="{{path_to_root}}img/carat.png" alt=""/>
           </span>
           {{name}} {{kind}} Reference
         </p>
@@ -91,5 +91,4 @@
       </div>
     </div>
   </body>
-</div>
 </html>

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="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>
+  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
 </section>

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

@@ -8,7 +8,7 @@
     {{#source_host_url}}
     <p class="header-right">
       <a href="{{.}}">
-        <img src="{{path_to_root}}img/{{source_host_image}}"/>
+        <img src="{{path_to_root}}img/{{source_host_image}}" alt="{{source_host_name}}"/>
         <span class="no-mobile">View on {{source_host_name}}</span>
       </a>
     </p>
@@ -17,7 +17,7 @@
     {{#dash_url}}
     <p class="header-right">
       <a href="{{dash_url}}">
-        <img src="{{path_to_root}}img/dash.png"/>
+        <img src="{{path_to_root}}img/dash.png" alt="Dash"/>
         <span class="no-mobile">Install in Dash</span>
       </a>
     </p>

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

@@ -28,16 +28,11 @@
         <a class="token discouraged" href="#/{{usr}}">{{{name_html}}}</a>
         {{/usage_discouraged}}
         </code>
-        {{#default_impl_abstract}}
+        {{#declaration_note}}
           <span class="declaration-note">
-            Default implementation
+            {{.}}
           </span>
-        {{/default_impl_abstract}}
-        {{#from_protocol_extension}}
-          <span class="declaration-note">
-            Extension method
-          </span>
-        {{/from_protocol_extension}}
+        {{/declaration_note}}
       </div>
       <div class="height-container">
         <div class="pointer-container"></div>

data/spec/integration_spec.rb

@@ -188,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
@@ -210,7 +211,8 @@ describe_cli 'jazzy' do
                               '--root-url https://realm.io/docs/swift/' \
                               "#{realm_version}/api/ " \
                               '--xcodebuild-arguments ' \
-                              '-scheme,RealmSwift,SWIFT_VERSION=4.2 ' \
+                              '-scheme,RealmSwift,SWIFT_VERSION=4.2,' \
+                              "-destination,'platform=OS X' " \
                               "--head #{realm_head.shellescape}"
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - JP Simard
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-14 00:00:00.000000000 Z
+date: 2021-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods