jazzy 0.15.1 → 0.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 233b49769d27b199b20651cff4041041fda0c9506945290fea84937ee5f1723f
-  data.tar.gz: 55148a0bff106913b60dd295851d069a8aa344a21c2b52e3453d1bbeebd2a8ad
+  metadata.gz: 9a5cf4da18c11cdb04965d69968cee0b16db1720e9a8f31b9b27fbd4eaddd8fd
+  data.tar.gz: 5efbaf91ef7e253a86a652b45c5fbfd512d7dccccbf06aa2b53190f8a8a135d9
 SHA512:
-  metadata.gz: f093b513515728c93ffce07528fe6042d05063b8b9b78e4283f89f9e41632a06509434bc3f533f2b4e1d9f30619cde090acff726a1463ea61669091f56734f41
-  data.tar.gz: 36ba08e16c04d207568ce01f1e864bee4d495197cdf14bbc643d714e3ea85aeff2c9c102e4baa7122916f49dbf2d3e77dcf59ecebfd4a9c1839b5eb9bf18e08d
+  metadata.gz: 62074603cb5b33f8809ae5f5d9c16c5381947f4187d6e58f4d08c47ba2408479568bb9631d3c293e6a53ed7bdd0237ca928f931af496d13bf60715e90bfb3844
+  data.tar.gz: db5f645a8a7a5deaf0f6f2776ad17010a28d948d2cda1e2c3c4e8cb1a23e0ab14ac773a00b9fd8a6c88fd76198d4c756ce1536ce500a18ede7e42bcfd02493bb

data/.github/workflows/Tests.yml

@@ -34,15 +34,16 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: recursive
+          persist-credentials: false
       - uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: 15.3
+          xcode-version: '16.0'
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 3.2
           bundler-cache: true
       - name: Cache cocoapods
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         env:
           cache-name: cocoapods
         with:

data/.rubocop.yml

@@ -8,10 +8,10 @@ AllCops:
   SuggestExtensions: false
   TargetRubyVersion: 2.6
 
-#- Pending Cops as of 1.56.3 ---------------------------------------------#
-
-
+#- Pending Cops as of 1.66.1 ---------------------------------------------#
 
+Gemspec/AddRuntimeDependency: # new in 1.65
+  Enabled: true
 Gemspec/DeprecatedAttributeAssignment: # new in 1.30
   Enabled: true
 Gemspec/DevelopmentDependencies: # new in 1.44
@@ -84,6 +84,8 @@ Lint/UnexpectedBlockArity: # (new in 1.5)
   Enabled: true
 Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
   Enabled: true
+Lint/UselessNumericOperation: # new in 1.66
+  Enabled: true
 Lint/UselessRescue: # new in 1.43
   Enabled: true
 Lint/UselessRuby2Keywords: # new in 1.23
@@ -188,6 +190,8 @@ Style/RedundantHeredocDelimiterQuotes: # new in 1.45
   Enabled: true
 Style/RedundantInitialize: # new in 1.27
   Enabled: true
+Style/RedundantInterpolationUnfreeze: # new in 1.66
+  Enabled: true
 Style/RedundantLineContinuation: # new in 1.49
   Enabled: true
 Style/RedundantRegexpArgument: # new in 1.53

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.15.2
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Support Swift 6.0 / Xcode 16.0  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Bug Fixes
+
+* None.
+
 ## 0.15.1
 
 ##### 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 15.3 installed to build the integration specs.
+You must have Xcode 16.0 installed to build the integration specs.
 
 ## Making changes to SourceKitten
 

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    jazzy (0.15.1)
+    jazzy (0.15.2)
       cocoapods (~> 1.5)
       mustache (~> 1.1)
       open4 (~> 1.3)
@@ -27,18 +27,19 @@ GEM
       base64
       nkf
       rexml
-    activesupport (7.1.3.4)
+    activesupport (7.2.1)
       base64
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     algoliasearch (1.27.5)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
@@ -90,14 +91,14 @@ GEM
       netrc (~> 0.11)
     cocoapods-try (1.2.0)
     colored2 (3.1.2)
-    concurrent-ruby (1.3.2)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     cork (0.3.0)
       colored2 (~> 3.1)
     crack (1.0.0)
       bigdecimal
       rexml
-    danger (9.4.3)
+    danger (9.5.0)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -107,7 +108,6 @@ GEM
       git (~> 1.13)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.0)
-      no_proxy_fix
       octokit (>= 4.0)
       terminal-table (>= 1, < 4)
     diffy (3.4.2)
@@ -115,11 +115,13 @@ GEM
     escape (0.0.4)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    faraday (2.9.1)
-      faraday-net_http (>= 2.0, < 3.2)
+    faraday (2.12.0)
+      faraday-net_http (>= 2.0, < 3.4)
+      json
+      logger
     faraday-http-cache (2.5.1)
       faraday (>= 0.8)
-    faraday-net_http (3.1.0)
+    faraday-net_http (3.3.0)
       net-http
     ffi (1.17.0)
     fourflusher (2.3.1)
@@ -128,9 +130,9 @@ GEM
     git (1.19.1)
       addressable (~> 2.8)
       rchardet (~> 1.8)
-    hashdiff (1.1.0)
+    hashdiff (1.1.1)
     httpclient (2.8.3)
-    i18n (1.14.5)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
     json (2.7.2)
     kramdown (2.4.0)
@@ -139,55 +141,51 @@ GEM
       kramdown (~> 2.0)
     language_server-protocol (3.17.0.3)
     liferaft (0.0.6)
+    logger (1.6.1)
     mini_portile2 (2.8.7)
-    minitest (5.23.1)
-    mocha (2.3.0)
+    minitest (5.25.1)
+    mocha (2.4.5)
       ruby2_keywords (>= 0.0.5)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
     molinillo (0.8.0)
     mustache (1.1.1)
-    mutex_m (0.2.0)
     nanaimo (0.3.0)
     nap (1.1.0)
     net-http (0.4.1)
       uri
     netrc (0.11.0)
     nkf (0.2.0)
-    no_proxy_fix (0.1.2)
-    octokit (8.1.0)
-      base64
+    octokit (9.1.0)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     open4 (1.3.4)
-    parallel (1.24.0)
-    parser (3.3.2.0)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
     prettybacon (0.0.2)
       bacon (~> 1.2)
     public_suffix (4.0.7)
-    racc (1.8.0)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
     rchardet (1.8.0)
     redcarpet (3.6.0)
     regexp_parser (2.9.2)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
-    rouge (4.2.1)
-    rubocop (1.64.1)
+    rexml (3.3.7)
+    rouge (4.4.0)
+    rubocop (1.66.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+    rubocop-ast (1.32.3)
       parser (>= 3.3.1.0)
     ruby-macho (2.5.1)
     ruby-progressbar (1.13.0)
@@ -197,30 +195,30 @@ GEM
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
+    securerandom (0.3.1)
     sqlite3 (1.7.3)
       mini_portile2 (~> 2.8.0)
-    strscan (3.1.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
-    uri (0.13.0)
+    unicode-display_width (2.6.0)
+    uri (0.13.1)
     webmock (3.23.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.24.0)
+    xcodeproj (1.25.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)
       colored2 (~> 3.1)
       nanaimo (~> 0.3.0)
-      rexml (~> 3.2.4)
+      rexml (>= 3.3.2, < 4.0)
 
 PLATFORMS
   ruby

data/jazzy.gemspec

@@ -18,15 +18,15 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split($/)
   spec.executables << 'jazzy'
 
-  spec.add_runtime_dependency 'cocoapods', '~> 1.5'
-  spec.add_runtime_dependency 'mustache', '~> 1.1'
-  spec.add_runtime_dependency 'open4', '~> 1.3'
-  spec.add_runtime_dependency 'redcarpet', '~> 3.4'
-  spec.add_runtime_dependency 'rexml', ['>= 3.2.7', '< 4.0']
-  spec.add_runtime_dependency 'rouge', ['>= 2.0.6', '< 5.0']
-  spec.add_runtime_dependency 'sassc', '~> 2.1'
-  spec.add_runtime_dependency 'sqlite3', '~> 1.3'
-  spec.add_runtime_dependency 'xcinvoke', '~> 0.3.0'
+  spec.add_dependency 'cocoapods', '~> 1.5'
+  spec.add_dependency 'mustache', '~> 1.1'
+  spec.add_dependency 'open4', '~> 1.3'
+  spec.add_dependency 'redcarpet', '~> 3.4'
+  spec.add_dependency 'rexml', ['>= 3.2.7', '< 4.0']
+  spec.add_dependency 'rouge', ['>= 2.0.6', '< 5.0']
+  spec.add_dependency 'sassc', '~> 2.1'
+  spec.add_dependency 'sqlite3', '~> 1.3'
+  spec.add_dependency 'xcinvoke', '~> 0.3.0'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13.0'

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/podspec_documenter.rb

@@ -102,7 +102,7 @@ module Jazzy
     private_class_method :github_file_prefix
 
     # Latest valid value for SWIFT_VERSION.
-    LATEST_SWIFT_VERSION = '5'
+    LATEST_SWIFT_VERSION = '6'
 
     # All valid values for SWIFT_VERSION that are longer
     # than a major version number.  Ordered ascending.

data/lib/jazzy/sourcekitten.rb

@@ -485,10 +485,19 @@ module Jazzy
       # @available attrs only in compiler 'interface' style
       extract_availability(doc['key.doc.declaration'] || '')
         .concat(extract_documented_attributes(annotated_decl_attrs))
+        .concat(fabricate_spi_attributes(doc, annotated_decl_attrs))
         .push(decl)
         .join("\n")
     end
 
+    # Swift 6 workaround: @_spi attribute & SPI group missing
+    def self.fabricate_spi_attributes(doc, attrs)
+      return [] unless spi_attribute?(doc)
+      return [] if attrs =~ /@_spi/
+
+      ['@_spi(<<unknown>>)']
+    end
+
     # Exclude non-async routines that accept async closures
     def self.swift_async?(fully_annotated_decl)
       document = REXML::Document.new(fully_annotated_decl)

data/lib/jazzy/symbol_graph/ext_node.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'set'
+
 module Jazzy
   module SymbolGraph
     # For extensions we need to track constraints of the extended type
@@ -26,7 +28,7 @@ module Jazzy
       attr_accessor :real_usr
       attr_accessor :name
       attr_accessor :all_constraints # ExtConstraints
-      attr_accessor :conformances # array, can be empty
+      attr_accessor :conformances # set, can be empty
 
       # Deduce an extension from a member of an unknown type or
       # of known type with additional constraints
@@ -54,7 +56,7 @@ module Jazzy
         self.usr = usr
         self.name = name
         self.all_constraints = constraints
-        self.conformances = []
+        self.conformances = Set.new
         super()
       end
 
@@ -65,13 +67,13 @@ module Jazzy
       end
 
       def add_conformance(protocol)
-        conformances.append(protocol).sort!
+        conformances.add(protocol)
       end
 
       def full_declaration
         decl = "extension #{name}"
         unless conformances.empty?
-          decl += " : #{conformances.join(', ')}"
+          decl += " : #{conformances.sort.join(', ')}"
         end
         decl + all_constraints.ext.to_where_clause
       end
@@ -90,7 +92,7 @@ module Jazzy
         }
 
         unless conformances.empty?
-          hash['key.inheritedtypes'] = conformances.map do |conformance|
+          hash['key.inheritedtypes'] = conformances.sort.map do |conformance|
             { 'key.name' => conformance }
           end
         end
@@ -100,11 +102,13 @@ module Jazzy
         hash
       end
 
-      # Sort order - by type name then constraint
+      # Sort order - by type name then constraint then conformances
+      # Conformance check needed for stable order with Swift 5.9
+      # extension symbols that can't merge as well as previously.
       include Comparable
 
       def sort_key
-        name + constraints.map(&:to_swift).join
+        name + constraints.map(&:to_swift).join + conformances.sort.join
       end
 
       def <=>(other)

data/lib/jazzy/symbol_graph/relationship.rb

@@ -34,7 +34,7 @@ module Jazzy
       # Protocol conformances added by compiler to actor decls that
       # users aren't interested in.
       def actor_protocol?
-        %w[Actor Sendable].include?(target_fallback)
+        %w[Actor AnyActor Sendable].include?(target_fallback)
       end
 
       def initialize(hash)

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

@@ -22,7 +22,7 @@ function itemLinkToContent($link) {
   return $link.parent().parent().next();
 }
 
-// On doc load + hash-change, open any targetted item
+// On doc load + hash-change, open any targeted item
 function openCurrentItemIfClosed() {
   if (window.jazzy.docset) {
     return;

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

@@ -22,7 +22,7 @@ function itemLinkToContent($link) {
   return $link.parent().parent().next();
 }
 
-// On doc load + hash-change, open any targetted item
+// On doc load + hash-change, open any targeted item
 function openCurrentItemIfClosed() {
   if (window.jazzy.docset) {
     return;

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

@@ -22,7 +22,7 @@ function itemLinkToContent($link) {
   return $link.parent().parent().next();
 }
 
-// On doc load + hash-change, open any targetted item
+// On doc load + hash-change, open any targeted item
 function openCurrentItemIfClosed() {
   if (window.jazzy.docset) {
     return;

data/spec/integration_spec.rb

@@ -146,6 +146,15 @@ describe_cli 'jazzy' do
 </script>
   HTML
 
+  realm_jazzy_yaml = <<-YAML
+build_tool_arguments:
+  - "-scheme"
+  - "RealmSwift"
+  - "SWIFT_VERSION=4.2"
+  - "-destination"
+  - "platform=OS X,arch=x86_64"
+  YAML
+
   spec_subset = ENV.fetch('JAZZY_SPEC_SUBSET', nil)
 
   # rubocop:disable Style/MultilineIfModifier
@@ -208,9 +217,15 @@ describe_cli 'jazzy' do
 
     describe 'Creates Realm Swift docs' do
       realm_version = ''
-      Dir.chdir(ROOT + 'spec/integration_specs/document_realm_swift/before') do
+      realm_path = ROOT + 'spec/integration_specs/document_realm_swift/before'
+      realm_jazzy_path = realm_path + '.jazzy.yaml'
+
+      Dir.chdir(realm_path) do
         realm_version = `./build.sh get-version`.chomp
       end
+      # Xcode 16 workaround
+      File.write(realm_jazzy_path, realm_jazzy_yaml)
+
       behaves_like cli_spec 'document_realm_swift',
                             '--author Realm ' \
                               '--author_url "https://realm.io" ' \
@@ -222,10 +237,8 @@ describe_cli 'jazzy' do
                               "--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}"
+      FileUtils.rm_rf realm_jazzy_path
     end
 
     describe 'Creates Siesta docs' do
@@ -249,7 +262,8 @@ describe_cli 'jazzy' do
       behaves_like cli_spec 'misc_jazzy_symgraph_features',
                             '--swift-build-tool symbolgraph ' \
                               '--build-tool-arguments ' \
-                              "-emit-extension-block-symbols,-I,#{module_path}"
+                              '-emit-extension-block-symbols,-I,' \
+                              "#{module_path.chomp}/Modules"
     end
 
     describe 'Creates docs for a multiple-module project' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.15.2
 platform: ruby
 authors:
 - JP Simard
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-08 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods