jazzy 0.15.4 → 0.15.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f99a69babed72b2f5c277beca7068ef6d49e6367251f36e4630352fd40929c73
-  data.tar.gz: 025bcd88cacf17a6627c2fc4c3f341a46db8da83324cf45c50ec21a98c1b129a
+  metadata.gz: 6512e08b5febcc111ae5af8a632ef2231de5fe4124b7f82d5644f439ff7db779
+  data.tar.gz: 74bf03412186f7638600bcb38b0fe3ccd7ed5237998273150573786f0414599b
 SHA512:
-  metadata.gz: 4f986fca818444ab04ccc43f9c0c601412a06fea9eec0e7443a7467f8716fd53b7abc5064c48cdc9c390162bd6ebae441e9b90de2b91fb1a363d47b9439e44c2
-  data.tar.gz: 9093d563676ddb2b6de9de7b654b55f41cfd63c36e86529d7d5588b05cf00c648b2b7fe11fa66cb726dd6e6d8fa5476c11b311eba8bf275bcfce20014d6e3925
+  metadata.gz: fcc7c2761c0976374961ad38c834fa14ac75146f4d05d5d6be5d61c03714c4107bcfd93543235f5d4a4438819fa58f94a6bea4eca68df44904c08db958e919b3
+  data.tar.gz: c059374937484bbb302e71fb83db2fd83892ccc55ea6c354282fc97c29d68520a3e4c32bef52fdc99d5a010c278fbb638de8127383336e54b965dc2e383a8d4f

data/.github/workflows/Tests.yml

@@ -10,7 +10,7 @@ jobs:
   danger_and_rubocop:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 3.3
@@ -25,25 +25,25 @@ jobs:
           bundle exec danger --verbose
 
   spec:
-    runs-on: macos-15
+    runs-on: xcode-27
     continue-on-error: true
     strategy:
       matrix:
         spec: ["objc_spec", "swift_spec", "cocoapods_spec"]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
         with:
           submodules: recursive
           persist-credentials: false
       - uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '26.1.0-beta'
+          xcode-version: '27.0.0'
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 3.3
           bundler-cache: true
       - name: Cache cocoapods
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         env:
           cache-name: cocoapods
         with:

data/.rubocop.yml

@@ -8,7 +8,7 @@ AllCops:
   SuggestExtensions: false
   TargetRubyVersion: 2.6
 
-#- Pending Cops as of 1.81.1 ---------------------------------------------#
+#- Pending Cops as of 1.91.0 ---------------------------------------------#
 
 Gemspec/AddRuntimeDependency: # new in 1.65
   Enabled: true
@@ -32,6 +32,8 @@ Lint/AmbiguousAssignment: # (new in 1.7)
   Enabled: true
 Lint/AmbiguousRange: # (new in 1.19)
   Enabled: true
+Lint/ArgumentMismatch: # new in 1.90
+  Enabled: true
 Lint/ArrayLiteralInRegexp: # new in 1.71
   Enabled: true
 Lint/ConstantOverwrittenInRescue: # new in 1.31
@@ -40,8 +42,12 @@ Lint/ConstantReassignment: # new in 1.70
   Enabled: true
 Lint/CopDirectiveSyntax: # new in 1.72
   Enabled: true
+Lint/DataDefineOverride: # new in 1.85
+  Enabled: true
 Lint/DeprecatedConstants: # (new in 1.8)
   Enabled: true
+Lint/DeprecatedReference: # new in 1.89
+  Enabled: true
 Lint/DuplicateBranch: # (new in 1.3)
   Enabled: true
 Lint/DuplicateMagicComment: # new in 1.37
@@ -68,8 +74,12 @@ Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
   Enabled: true
 Lint/LiteralAssignmentInCondition: # new in 1.58
   Enabled: true
+Lint/MisplacedMagicComment: # new in 1.91
+  Enabled: true
 Lint/MixedCaseRange: # new in 1.53
   Enabled: true
+Lint/NameTypo: # new in 1.89
+  Enabled: true
 Lint/NonAtomicFileOperation: # new in 1.31
   Enabled: true
 Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
@@ -94,6 +104,8 @@ Lint/RequireRelativeSelfPath: # new in 1.22
   Enabled: true
 Lint/SharedMutableDefault: # new in 1.70
   Enabled: true
+Lint/SuperArgumentMismatch: # new in 1.90
+  Enabled: true
 Lint/SuppressedExceptionInNumberConversion: # new in 1.72
   Enabled: true
 Lint/SymbolConversion: # (new in 1.9)
@@ -108,6 +120,8 @@ Lint/UnexpectedBlockArity: # (new in 1.5)
   Enabled: true
 Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
   Enabled: true
+Lint/UnreachablePatternBranch: # new in 1.85
+  Enabled: true
 Lint/UselessConstantScoping: # new in 1.72
   Enabled: true
 Lint/UselessDefaultValueArgument: # new in 1.76
@@ -160,10 +174,14 @@ Style/DataInheritance: # new in 1.49
   Enabled: true
 Style/DigChain: # new in 1.69
   Enabled: true
+Style/DirectiveScope: # new in 1.90
+  Enabled: true
 Style/DirEmpty: # new in 1.48
   Enabled: true
 Style/DocumentDynamicEvalDefinition: # (new in 1.1)
   Enabled: true
+Style/EmptyClassDefinition: # new in 1.84
+  Enabled: true
 Style/EmptyHeredoc: # new in 1.32
   Enabled: true
 Style/EmptyStringInsideInterpolation: # new in 1.76
@@ -180,6 +198,8 @@ Style/FileEmpty: # new in 1.48
   Enabled: true
 Style/FileNull: # new in 1.69
   Enabled: true
+Style/FileOpen: # new in 1.85
+  Enabled: true
 Style/FileRead: # new in 1.24
   Enabled: true
 Style/FileTouch: # new in 1.69
@@ -210,16 +230,22 @@ Style/MapCompactWithConditionalBlock: # new in 1.30
   Enabled: true
 Style/MapIntoArray: # new in 1.63
   Enabled: true
+Style/MapJoin: # new in 1.85
+  Enabled: true
 Style/MapToHash: # new in 1.24
   Enabled: true
 Style/MapToSet: # new in 1.42
   Enabled: true
 Style/MinMaxComparison: # new in 1.42
   Enabled: true
+Style/ModuleMemberExistenceCheck: # new in 1.82
+  Enabled: true
 Style/MultilineInPatternThen: # (new in 1.16)
   Enabled: true
 Style/NegatedIfElseCondition: # (new in 1.2)
   Enabled: true
+Style/NegativeArrayIndex: # new in 1.84
+  Enabled: true
 Style/NestedFileDirname: # new in 1.26
   Enabled: true
 Style/NilLambda: # (new in 1.3)
@@ -234,8 +260,14 @@ Style/OpenStructUse: # new in 1.23
   Enabled: true
 Style/OperatorMethodCall: # new in 1.37
   Enabled: true
+Style/PartitionInsteadOfDoubleSelect: # new in 1.85
+  Enabled: true
+Style/PredicateWithKind: # new in 1.85
+  Enabled: true
 Style/QuotedSymbols: # (new in 1.16)
   Enabled: true
+Style/ReduceToHash: # new in 1.85
+  Enabled: true
 Style/RedundantArgument: # (new in 1.4)
   Enabled: true
 Style/RedundantArrayConstructor: # new in 1.52
@@ -262,6 +294,8 @@ Style/RedundantInterpolationUnfreeze: # new in 1.66
   Enabled: true
 Style/RedundantLineContinuation: # new in 1.49
   Enabled: true
+Style/RedundantMinMaxBy: # new in 1.85
+  Enabled: true
 Style/RedundantRegexpArgument: # new in 1.53
   Enabled: true
 Style/RedundantRegexpConstructor: # new in 1.52
@@ -272,8 +306,14 @@ Style/RedundantStringEscape: # new in 1.37
   Enabled: true
 Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
   Enabled: true
+Style/ReverseFind: # new in 1.84
+  Enabled: true
 Style/SafeNavigationChainLength: # new in 1.68
   Enabled: true
+Style/SelectByKind: # new in 1.85
+  Enabled: true
+Style/SelectByRange: # new in 1.85
+  Enabled: true
 Style/SelectByRegexp: # new in 1.22
   Enabled: true
 Style/SendWithLiteralMethodName: # new in 1.64
@@ -288,6 +328,10 @@ Style/SuperWithArgsParentheses: # new in 1.58
   Enabled: true
 Style/SwapValues: # (new in 1.1)
   Enabled: true
+Style/TallyMethod: # new in 1.85
+  Enabled: true
+Style/TimeNow: # new in 1.90
+  Enabled: true
 Style/YAMLFileRead: # new in 1.53
   Enabled: true
 
@@ -388,6 +432,10 @@ Style/RegexpLiteral:
 Style/AccessorGrouping:
   Enabled: false
 
+# Too restrictive
+Style/OneClassPerFile:
+  Enabled: false
+
 # Avoid mandatory wide indentation
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 0.15.5
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Generate docs using SwiftPM 6.4  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Support mustache 1.1.3  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1435](https://github.com/realm/jazzy/issues/1435)
+
+##### Bug Fixes
+
+* None.
+
 ## 0.15.4
 
 ##### Breaking

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    jazzy (0.15.4)
+    jazzy (0.15.5)
       activesupport (>= 5.0, < 8)
       cocoapods (~> 1.5)
       logger
@@ -19,17 +19,14 @@ PATH
       rexml (>= 3.2.7, < 4.0)
       rouge (>= 2.0.6, < 5.0)
       sassc (~> 2.1)
-      sqlite3 (~> 1.3)
+      sqlite3 (>= 1.3, < 3.0)
       xcinvoke (~> 0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    CFPropertyList (3.0.7)
-      base64
-      nkf
-      rexml
-    activesupport (7.2.2.2)
+    CFPropertyList (3.0.8)
+    activesupport (7.2.3.2)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -38,11 +35,11 @@ GEM
       drb
       i18n (>= 1.6, < 2)
       logger (>= 1.4.2)
-      minitest (>= 5.1)
+      minitest (>= 5.1, < 6)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
     algoliasearch (1.27.5)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
@@ -50,17 +47,17 @@ GEM
     atomos (0.1.3)
     bacon (1.2.0)
     base64 (0.3.0)
-    benchmark (0.4.1)
-    bigdecimal (3.3.1)
+    benchmark (0.5.0)
+    bigdecimal (4.1.3)
     claide (1.1.0)
     claide-plugins (0.9.2)
       cork
       nap
       open4 (~> 1.3)
-    cocoapods (1.16.2)
+    cocoapods (1.17.0)
       addressable (~> 2.8)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.16.2)
+      cocoapods-core (= 1.17.0)
       cocoapods-deintegrate (>= 1.0.3, < 2.0)
       cocoapods-downloader (>= 2.1, < 3.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -68,14 +65,13 @@ GEM
       cocoapods-trunk (>= 1.6.0, < 2.0)
       cocoapods-try (>= 1.1.0, < 2.0)
       colored2 (~> 3.1)
-      escape (~> 0.0.4)
       fourflusher (>= 2.3.0, < 3.0)
       gh_inspector (~> 1.0)
       molinillo (~> 0.8.0)
       nap (~> 1.0)
-      ruby-macho (>= 2.3.0, < 3.0)
-      xcodeproj (>= 1.27.0, < 2.0)
-    cocoapods-core (1.16.2)
+      ruby-macho (~> 4.1.0)
+      xcodeproj (>= 1.28.1, < 2.0)
+    cocoapods-core (1.17.0)
       activesupport (>= 5.0, < 8)
       addressable (~> 2.8)
       algoliasearch (~> 1.0)
@@ -95,14 +91,14 @@ GEM
       netrc (~> 0.11)
     cocoapods-try (1.2.0)
     colored2 (3.1.2)
-    concurrent-ruby (1.3.5)
-    connection_pool (2.5.4)
+    concurrent-ruby (1.3.8)
+    connection_pool (3.0.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    crack (1.0.0)
+    crack (1.0.1)
       bigdecimal
       rexml
-    danger (9.5.3)
+    danger (9.6.1)
       base64 (~> 0.2)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
@@ -110,7 +106,7 @@ GEM
       cork (~> 0.1)
       faraday (>= 0.9.0, < 3.0)
       faraday-http-cache (~> 2.0)
-      git (>= 1.13, < 3.0)
+      git (>= 1.13)
       kramdown (>= 2.5.1, < 3.0)
       kramdown-parser-gfm (~> 1.0)
       octokit (>= 4.0)
@@ -118,124 +114,128 @@ GEM
       terminal-table (>= 1, < 5)
     diffy (3.4.4)
     drb (2.2.3)
-    escape (0.0.4)
-    ethon (0.15.0)
+    ethon (0.18.0)
       ffi (>= 1.15.0)
-    faraday (2.14.0)
+      logger
+    faraday (2.14.4)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-http-cache (2.5.1)
+    faraday-http-cache (2.8.0)
       faraday (>= 0.8)
-    faraday-net_http (3.4.1)
-      net-http (>= 0.5.0)
-    ffi (1.17.2)
+    faraday-net_http (3.4.4)
+      net-http (~> 0.5)
+    ffi (1.17.4)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    git (2.3.3)
+    git (5.6.0)
       activesupport (>= 5.0)
       addressable (~> 2.8)
-      process_executer (~> 1.1)
-      rchardet (~> 1.8)
+      process_executer (~> 4.1)
+      rchardet (~> 1.9)
     hashdiff (1.2.1)
     httpclient (2.9.0)
       mutex_m
-    i18n (1.14.7)
+    i18n (1.15.2)
       concurrent-ruby (~> 1.0)
-    json (2.15.1)
-    kramdown (2.5.1)
-      rexml (>= 3.3.9)
+    json (3.0.2)
+    kramdown (2.5.2)
+      rexml (>= 3.4.4)
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    language_server-protocol (3.17.0.5)
+    language_server-protocol (3.17.0.6)
     liferaft (0.0.6)
     lint_roller (1.1.0)
     logger (1.7.0)
     mini_portile2 (2.8.9)
-    minitest (5.26.0)
-    mocha (2.7.1)
+    minitest (5.27.0)
+    mocha (3.1.0)
       ruby2_keywords (>= 0.0.5)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
     molinillo (0.8.0)
-    mustache (1.1.1)
+    mustache (1.1.3)
     mutex_m (0.3.0)
     nanaimo (0.4.0)
     nap (1.1.0)
-    net-http (0.6.0)
-      uri
+    net-http (0.9.1)
+      uri (>= 0.11.1)
     netrc (0.11.0)
-    nkf (0.2.0)
+    nkf (0.3.0)
     octokit (10.0.0)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     open4 (1.3.4)
-    parallel (1.27.0)
-    parser (3.3.9.0)
+    parallel (2.2.0)
+    parser (3.3.12.0)
       ast (~> 2.4.1)
       racc
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    prism (1.6.0)
-    process_executer (1.3.0)
-    pstore (0.2.0)
+    prism (1.9.0)
+    process_executer (4.1.1)
+      track_open_instances (~> 0.1)
+    pstore (0.2.1)
     public_suffix (4.0.7)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.3.0)
-    rchardet (1.10.0)
+    rake (13.4.2)
+    rchardet (1.10.2)
     redcarpet (3.6.1)
-    regexp_parser (2.11.3)
+    regexp_parser (2.13.1)
     rexml (3.4.4)
-    rouge (4.6.1)
-    rubocop (1.81.1)
-      json (~> 2.3)
+    rouge (4.7.0)
+    rubocop (1.91.0)
+      json (>= 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.47.1, < 2.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.47.1)
+    rubocop-ast (1.50.0)
       parser (>= 3.3.7.2)
-      prism (~> 1.4)
-    ruby-macho (2.5.1)
+      prism (~> 1.7)
+    ruby-macho (4.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     sassc (2.4.0)
       ffi (~> 1.9)
-    sawyer (0.9.2)
+    sawyer (0.9.3)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
     securerandom (0.4.1)
-    sqlite3 (1.7.3)
+    sqlite3 (2.9.6)
       mini_portile2 (~> 2.8.0)
     terminal-table (4.0.0)
       unicode-display_width (>= 1.1.1, < 4)
-    typhoeus (1.5.0)
-      ethon (>= 0.9.0, < 0.16.0)
+    track_open_instances (0.1.15)
+    typhoeus (1.6.0)
+      ethon (>= 0.18.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (3.2.0)
-      unicode-emoji (~> 4.1)
-    unicode-emoji (4.1.0)
-    uri (1.0.4)
-    webmock (3.25.1)
+    unicode-display_width (3.3.0)
+      unicode-emoji (~> 4.3)
+    unicode-emoji (4.3.0)
+    uri (1.1.1)
+    webmock (3.26.4)
       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.27.0)
+    xcodeproj (1.28.1)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
+      base64
       claide (>= 1.0.2, < 2.0)
       colored2 (~> 3.1)
       nanaimo (~> 0.4.0)
+      nkf
       rexml (>= 3.3.6, < 4.0)
 
 PLATFORMS
@@ -243,7 +243,7 @@ PLATFORMS
 
 DEPENDENCIES
   bacon
-  bundler (~> 2.1)
+  bundler (~> 4.0)
   clintegracon!
   danger
   diffy
@@ -256,4 +256,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.3.26
+  4.0.22

data/README.md

@@ -358,7 +358,7 @@ of the modules being documented.
 
 Three themes are provided with jazzy: `apple` (default), `fullwidth` and `jony`.
 
-* `apple` example: <https://realm.io/docs/swift/latest/api/>
+* `apple` example: <https://johnfairh.github.io/demo-jazzy-apple-theme/>
 * `fullwidth` example: <https://reduxkit.github.io/ReduxKit/>
 * `jony` example: <https://harshilshah.github.io/IGListKit/>
 

data/jazzy.gemspec

@@ -27,10 +27,10 @@ Gem::Specification.new do |spec|
   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 'sqlite3', ['>= 1.3', '< 3.0']
   spec.add_dependency 'xcinvoke', '~> 0.3.0'
 
-  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'bundler', '~> 4.0'
   spec.add_development_dependency 'rake', '~> 13.0'
 
   spec.required_ruby_version = '>= 2.6.3'

data/lib/jazzy/config.rb

@@ -8,9 +8,9 @@ require 'jazzy/podspec_documenter'
 require 'jazzy/source_declaration/access_control_level'
 
 module Jazzy
-  # rubocop:disable Metrics/ClassLength
+  # rubocop:disable-next Metrics/ClassLength
   class Config
-    # rubocop:disable Naming/AccessorMethodName
+    # rubocop:disable-next Naming/AccessorMethodName
     class Attribute
       attr_reader :name, :description, :command_line, :config_file_key,
                   :default, :parse, :per_module
@@ -74,7 +74,6 @@ module Jazzy
         end
       end
     end
-    # rubocop:enable Naming/AccessorMethodName
 
     def self.config_attr(name, **opts)
       attr_accessor name
@@ -543,7 +542,7 @@ module Jazzy
 
     def theme_directory=(theme_directory)
       @theme_directory = theme_directory
-      Doc.template_path = theme_directory + 'templates'
+      Doc.template_path = (theme_directory + 'templates').to_s
     end
 
     def self.parse!
@@ -563,7 +562,7 @@ module Jazzy
       warn "WARNING: #{message}"
     end
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable-next Metrics/MethodLength
     def parse_command_line
       OptionParser.new do |opt|
         opt.banner = 'Usage: jazzy'
@@ -669,8 +668,6 @@ module Jazzy
       end
     end
 
-    # rubocop:enable Metrics/MethodLength
-
     # Module Configs
     #
     # The user can enter module information in three different ways.  This
@@ -791,7 +788,7 @@ module Jazzy
           puts attr.name.to_s.tr('_', ' ').upcase
           puts
           puts "  Config file:   #{attr.config_file_key}"
-          cmd_line_forms = attr.command_line.select { |opt| opt.is_a?(String) }
+          cmd_line_forms = attr.command_line.grep(String)
           if cmd_line_forms.any?
             puts "  Command line:  #{cmd_line_forms.join(', ')}"
           end
@@ -839,5 +836,4 @@ module Jazzy
       end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/jazzy/doc_builder.rb

@@ -299,8 +299,8 @@ module Jazzy
       end
     end
 
-    # rubocop:disable Metrics/MethodLength
-
+    # rubocop:disable-next Metrics/MethodLength
+    #
     # Generates an SVG similar to those from shields.io displaying the
     # documentation percentage
     # @param [Number] coverage The documentation coverage percentage
@@ -346,12 +346,11 @@ module Jazzy
       badge_output = options.output + 'badge.svg'
       File.open(badge_output, 'w') { |f| f << svg }
     end
-    # rubocop:enable Metrics/MethodLength
 
     # Build mustache item for a top-level doc
     # @param [Hash] item Parsed doc child item
     # @param [Config] options Build options
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable-next Metrics/MethodLength
     def self.render_item(item, source_module)
       # Combine abstract and discussion into abstract
       abstract = (item.abstract || '') + (item.discussion || '')
@@ -382,7 +381,6 @@ module Jazzy
         declaration_note: item.declaration_note,
       }
     end
-    # rubocop:enable Metrics/MethodLength
 
     def self.make_task(mark, uid, items, doc_model)
       {
@@ -415,7 +413,7 @@ module Jazzy
       end
     end
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable-next Metrics/MethodLength
     # Build Mustache document from single parsed decl
     # @param [SourceModule] module-wide settings
     # @param [Hash] doc_model Parsed doc. @see SourceKitten.parse
@@ -449,7 +447,6 @@ module Jazzy
       doc[:usage_discouraged] = doc_model.usage_discouraged?
       doc.render.gsub(ELIDED_AUTOLINK_TOKEN, path_to_root)
     end
-    # rubocop:enable Metrics/MethodLength
 
     # Breadcrumbs for a page - doesn't include the top 'readme' crumb
     def self.make_breadcrumbs(doc_model)

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/jazzy_markdown.rb

@@ -45,7 +45,7 @@ module Jazzy
       end
     end
 
-    # rubocop:disable Metrics/ClassLength
+    # rubocop:disable-next Metrics/ClassLength
     class JazzyHTML < Redcarpet::Render::HTML
       include Redcarpet::Render::SmartyPants
       include Rouge::Plugins::Redcarpet
@@ -195,7 +195,6 @@ module Jazzy
         Highlighter::Formatter.new(lexer.tag)
       end
     end
-    # rubocop:enable Metrics/ClassLength
 
     REDCARPET_OPTIONS = {
       autolink: true,

data/lib/jazzy/podspec_documenter.rb

@@ -4,7 +4,7 @@ require 'tmpdir'
 require 'json'
 
 module Jazzy
-  # rubocop:disable Metrics/ClassLength
+  # rubocop:disable-next Metrics/ClassLength
   class PodspecDocumenter
     attr_reader :podspec
 
@@ -44,7 +44,7 @@ module Jazzy
       end
     end
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable-next Metrics/MethodLength
     def self.apply_config_defaults(podspec, config)
       return unless podspec
 
@@ -74,7 +74,6 @@ module Jazzy
         config.swift_version_configured = true
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
     private
 
@@ -141,7 +140,7 @@ module Jazzy
       end
     end
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable-next Metrics/MethodLength
     def podfile(config)
       swift_version = compiler_swift_version(config.swift_version)
       podspec = @podspec
@@ -174,7 +173,5 @@ module Jazzy
         end
       end
     end
-    # rubocop:enable Metrics/MethodLength
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/jazzy/search_builder.rb

@@ -1,5 +1,33 @@
 # frozen_string_literal: true
 
+# Workarounds for:
+# 1. CocoaPods has died leaving a dep on activesupport < 8.0
+# 2. JSON (builtin) is now at 3.0+
+# 3. JSON 3+ is not supported by activesupport < 8.0
+#
+# Try to support CocoaPods for one more year by patching the
+# problematic methods.
+
+module JSON
+  class << self
+    # Store a reference to the original json gem's parse method
+    alias real_parse parse
+    alias real_generate generate
+
+    def parse(source, **opts)
+      opts = opts.dup
+      opts.delete(:quirks_mode)
+      real_parse(source, **opts)
+    end
+
+    def generate(source, **opts)
+      opts = opts.dup
+      opts.delete(:quirks_mode)
+      real_generate(source, **opts)
+    end
+  end
+end
+
 module Jazzy
   module SearchBuilder
     def self.build(source_module, output_dir)

data/lib/jazzy/source_declaration/type.rb

@@ -6,7 +6,7 @@ require 'active_support/inflector'
 
 module Jazzy
   class SourceDeclaration
-    # rubocop:disable Metrics/ClassLength
+    # rubocop:disable-next Metrics/ClassLength
     class Type
       def self.all
         TYPES.keys.map { |k| new(k) }.reject { |t| t.name.nil? }
@@ -471,6 +471,5 @@ module Jazzy
         }.freeze,
       }.freeze
     end
-    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/jazzy/source_declaration.rb

@@ -4,7 +4,7 @@ require 'jazzy/source_declaration/access_control_level'
 require 'jazzy/source_declaration/type'
 
 module Jazzy
-  # rubocop:disable Metrics/ClassLength
+  # rubocop:disable-next Metrics/ClassLength
   class SourceDeclaration
     # kind of declaration (e.g. class, variable, function)
     attr_accessor :type
@@ -296,5 +296,4 @@ module Jazzy
       Config.instance.abstract_glob.select { |e| File.file? e }
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/jazzy/sourcekitten.rb

@@ -76,7 +76,7 @@ module Jazzy
       end
     end
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable-next Metrics/MethodLength
     # Generate doc URL by prepending its parents' URLs
     # @return [Hash] input docs with URLs
     def self.make_doc_urls(docs)
@@ -111,7 +111,6 @@ module Jazzy
         end
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
     # Determine the subdirectory in which a doc should be placed.
     # Guides in the root for back-compatibility.
@@ -532,9 +531,9 @@ module Jazzy
                                declaration.mark_for_children)
     end
 
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable-next Metrics/MethodLength
+    # rubocop:disable-next Metrics/CyclomaticComplexity
+    # rubocop:disable-next Metrics/PerceivedComplexity
     def self.make_source_declarations(docs, parent = nil, mark = SourceMark.new)
       declarations = []
       current_mark = mark
@@ -627,9 +626,6 @@ module Jazzy
       end
       declarations
     end
-    # rubocop:enable Metrics/PerceivedComplexity
-    # rubocop:enable Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/MethodLength
 
     def self.find_generic_requirements(parsed_declaration)
       parsed_declaration =~ /\bwhere\s+(.*)$/m
@@ -755,8 +751,8 @@ module Jazzy
       end
     end
 
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable-next Metrics/MethodLength
+    # rubocop:disable-next Metrics/PerceivedComplexity
     # Merges all of the given types and extensions into a single document.
     def self.merge_declarations(decls)
       extensions, typedecls = decls.partition { |d| d.type.extension? }
@@ -789,8 +785,6 @@ module Jazzy
         merge_type_and_extensions(typedecls, extensions)
       end
     end
-    # rubocop:enable Metrics/PerceivedComplexity
-    # rubocop:enable Metrics/MethodLength
 
     def self.merge_type_and_extensions(typedecls, extensions)
       # Constrained extensions at the end

data/lib/jazzy/symbol_graph/graph.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/ClassLength
+# rubocop:disable-next Metrics/ClassLength
 module Jazzy
   module SymbolGraph
     # A Graph is the coordinator to import a symbolgraph json file.
@@ -209,4 +209,3 @@ module Jazzy
     end
   end
 end
-# rubocop:enable Metrics/ClassLength

data/lib/jazzy/symbol_graph/symbol.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/ClassLength
+# rubocop:disable-next Metrics/ClassLength
 module Jazzy
   module SymbolGraph
     # A Symbol is a tidied-up SymbolGraph JSON object
@@ -274,4 +274,3 @@ module Jazzy
     end
   end
 end
-# rubocop:enable Metrics/ClassLength

data/spec/integration_spec.rb

@@ -113,16 +113,12 @@ describe_cli 'jazzy' do
     # Remove version numbers from CocoaPods dependencies
     # to make specs resilient against dependency updates.
     s.replace_pattern(/(Installing \w+ )\((.*)\)/, '\1(X.Y.Z)')
-    # Xcode 13.3 etc workaround
-    s.replace_pattern(/202[\d.:\- ]+xcodebuild.*?\n/, '')
-    # Xcode 14 / in-proc sourcekitd workaround
-    s.replace_pattern(/<unknown>:0: remark.*?\n/, '')
     # CLIntegracon 0.8
     s.replace_pattern(%r{/transformed/}, '/')
-    # Xcode 15 workaround
-    s.replace_pattern(/objc\[.....\]: Class _?DTX\w+ is implemented in both.*?\n/, '')
     # arm vs. intel workaround
     s.replace_pattern(%r{(?<=build/)(arm64|x86_64)(?=-apple)}, '')
+    # Xcode install dependencies
+    s.replace_pattern(/^{ platform:.*\n/, '')
   end
 
   require 'shellwords'
@@ -146,15 +142,6 @@ 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
@@ -165,9 +152,11 @@ build_tool_arguments:
       relative_path = 'spec/integration_specs/document_realm_objc/before'
       Dir.chdir(ROOT + relative_path) do
         realm_version = `./build.sh get-version`.chomp
+        `./build.sh update-core`
         # jazzy will fail if it can't find all public header files
         `touch Realm/RLMPlatform.h`
       end
+
       behaves_like cli_spec 'document_realm_objc',
                             '--objc ' \
                               '--author Realm ' \
@@ -212,25 +201,31 @@ build_tool_arguments:
                             '--skip-undocumented ' \
                               '--clean ' \
                               '--xcodebuild-arguments ' \
-                              "-destination,'platform=OS X'"
+                              "-destination,'platform=OS X',__DIAGNOSE_INVALID_DEPLOYMENT_TARGET_AS_ERROR=NO"
     end
 
     describe 'Creates Realm Swift docs' do
       realm_version = ''
       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
+        `./build.sh download-core`
       end
-      # Xcode 16 workaround
-      File.write(realm_jazzy_path, realm_jazzy_yaml)
+
+      build_patch = ROOT + 'spec/realm-build.sh'
+      build_used = ROOT + realm_path + 'build.sh'
+      build_save = ROOT + 'spec/realm-build.sh.safe'
+      FileUtils.cp_r build_used, build_save, remove_destination: true
+      FileUtils.cp_r build_patch, build_used, remove_destination: true
 
       behaves_like cli_spec 'document_realm_swift',
                             '--author Realm ' \
                               '--author_url "https://realm.io" ' \
                               '--source-host-url ' \
                               'https://github.com/realm/realm-cocoa ' \
+                              '--xcodebuild-arguments ' \
+                              '-scheme,RealmSwift ' \
                               '--source-host-files-url https://github.com/realm/' \
                               "realm-cocoa/tree/v#{realm_version} " \
                               '--module RealmSwift ' \
@@ -238,7 +233,9 @@ build_tool_arguments:
                               '--root-url https://realm.io/docs/swift/' \
                               "#{realm_version}/api/ " \
                               "--head #{realm_head.shellescape}"
-      FileUtils.rm_rf realm_jazzy_path
+
+      FileUtils.cp_r build_save, build_used, remove_destination: true
+      FileUtils.rm_rf build_save
     end
 
     describe 'Creates Siesta docs' do
@@ -246,7 +243,8 @@ build_tool_arguments:
       # Use the default Swift version rather than the specified 4.0
       behaves_like cli_spec 'document_siesta',
                             '--output api-docs ' \
-                              '--swift-version= '
+                              '--swift-version= ' \
+                              '--xcodebuild-arguments __DIAGNOSE_INVALID_DEPLOYMENT_TARGET_AS_ERROR=NO'
     end
 
     describe 'Creates docs for Swift project with a variety of contents' do
@@ -257,13 +255,14 @@ build_tool_arguments:
       build_path = Dir.getwd + '/tmp/.build'
       package_path =
         ROOT + 'spec/integration_specs/misc_jazzy_symgraph_features/before'
-      `swift build --package-path #{package_path} --scratch-path #{build_path}`
-      module_path = `swift build --scratch-path #{build_path} --show-bin-path`
+      path_args = "--package-path #{package_path} --scratch-path #{build_path}"
+      `swift build #{path_args}`
+      module_path = `swift build #{path_args} --show-bin-path`
       behaves_like cli_spec 'misc_jazzy_symgraph_features',
                             '--swift-build-tool symbolgraph ' \
                               '--build-tool-arguments ' \
                               '-emit-extension-block-symbols,-I,' \
-                              "#{module_path.chomp}/Modules"
+                              "#{module_path.chomp}"
     end
 
     describe 'Creates docs for a multiple-module project' do
@@ -271,21 +270,23 @@ build_tool_arguments:
     end
   end if !spec_subset || spec_subset == 'swift'
 
-  describe 'jazzy cocoapods' do
-    # Xcode 14.3 workaround, special podspec
-    podspec_patch = ROOT + 'spec/Moya.podspec'
-    podspec_used = ROOT + 'spec/integration_specs/document_moya_podspec/before/Moya.podspec'
-    podspec_save = ROOT + 'spec/Moya.podspec.safe'
-    FileUtils.cp_r podspec_used, podspec_save, remove_destination: true
-    FileUtils.cp_r podspec_patch, podspec_used, remove_destination: true
-    configure_cocoapods
-    describe 'Creates docs for a podspec with dependencies and subspecs' do
-      behaves_like cli_spec 'document_moya_podspec',
-                            '--podspec=Moya.podspec'
-    end
-    FileUtils.cp_r podspec_save, podspec_used, remove_destination: true
-    FileUtils.rm_rf podspec_save
-  end if !spec_subset || spec_subset == 'cocoapods'
+  # Can't build on xcode27 because alamofire dep has bad ios deployment level
+  #
+  #  describe 'jazzy cocoapods' do
+  #    # Xcode 14.3 workaround, special podspec
+  #    podspec_patch = ROOT + 'spec/Moya.podspec'
+  #    podspec_used = ROOT + 'spec/integration_specs/document_moya_podspec/before/Moya.podspec'
+  #    podspec_save = ROOT + 'spec/Moya.podspec.safe'
+  #    FileUtils.cp_r podspec_used, podspec_save, remove_destination: true
+  #    FileUtils.cp_r podspec_patch, podspec_used, remove_destination: true
+  #    configure_cocoapods
+  #    describe 'Creates docs for a podspec with dependencies and subspecs' do
+  #      behaves_like cli_spec 'document_moya_podspec',
+  #                            '--podspec=Moya.podspec'
+  #    end
+  #    FileUtils.cp_r podspec_save, podspec_used, remove_destination: true
+  #    FileUtils.rm_rf podspec_save
+  #  end if !spec_subset || spec_subset == 'cocoapods'
 
   # rubocop:enable Style/MultilineIfModifier
 end

data/spec/realm-build.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+/usr/libexec/PlistBuddy -c "Print :CFBundleShortVersionString" Realm/Realm-Info.plist

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.15.4
+  version: 0.15.5
 platform: ruby
 authors:
 - JP Simard
@@ -160,16 +160,22 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: xcinvoke
   requirement: !ruby/object:Gem::Requirement
@@ -190,14 +196,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -393,6 +399,7 @@ files:
 - lib/jazzy/themes/jony/templates/tasks.mustache
 - spec/Moya.podspec
 - spec/integration_spec.rb
+- spec/realm-build.sh
 - spec/spec_helper.rb
 - spec/spec_helper/pre_flight.rb
 homepage: https://github.com/realm/jazzy
@@ -414,7 +421,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.17
 specification_version: 4
 summary: Soulful docs for Swift & Objective-C.
 test_files: []