jazzy 0.13.5 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b896e2cc19ed17de08bbaf77655ce4cc28ba3b086c4b324c6f3c15d3f61c5c2
-  data.tar.gz: 6dda6fa99cc9c4282f3818f405f218b23d22e57b6869be208082e36b25873dd0
+  metadata.gz: 5f55576dbfb09517321b17ea90b50e672c8ad6c50c563e087b381849ed2f7445
+  data.tar.gz: 9a5c54d86a73cf125109bd87a0f669c9807b419aa41f54174544d3ebd86632d2
 SHA512:
-  metadata.gz: 7d3a45bc3b94976166452b9ddf2c411dff01acedd555ba7b124f5eb66c078f5cdab652958a83017e1a253384b874316bf25e523a6eb6f814eb8c04b282063ee5
-  data.tar.gz: e7816087c597af5c4811f7c1155160242268b6beb25c610d93f571e749bc2c92edc7633712eed492d882d23f9576af98637ef46e8857ed4f547608ede6387439
+  metadata.gz: 61f70f156605dacf0b066262b7ccf694902117ce483fc056fa669af232530a7da180ed70134e1c0b8570f8ad55228c3324b53007e6f9d0519fe306977bd40b1e
+  data.tar.gz: 7655c01fd0c0bc9113b532b2e0531e56faf0aa00a5815a9713ca35b4cfa1fb45c391f6b77b4cd8501bce34ed4617c84dc1e2e436afda7bf8721d715ddb917d70

data/.github/workflows/Tests.yml

@@ -0,0 +1,52 @@
+name: Tests
+  
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: ['*']
+
+jobs:
+  danger_and_rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+          bundler-cache: true
+      - name: Danger
+        env:
+          DANGER_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          bundle exec danger --verbose
+      - name: Rubocop
+        run: |
+          bundle exec rake rubocop
+
+  spec:
+    runs-on: macos-11
+    continue-on-error: true
+    strategy:
+      matrix:
+        spec: ["objc_spec", "swift_spec", "cocoapods_spec"]
+    env:
+      DEVELOPER_DIR: /Applications/Xcode_13.0.app/Contents/Developer
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+          bundler-cache: true
+      - name: Cache cocoapods
+        uses: actions/cache@v2
+        env:
+          cache-name: cocoapods
+        with:
+          path: ~/.cocoapods
+          key: ${{ matrix.spec }}-${{ env.cache-name }}
+      - name: Test
+        run: |
+          bundle exec rake ${{ matrix.spec }}

data/.rubocop.yml

@@ -1,16 +1,104 @@
 AllCops:
-  Include:
-    - ./Rakefile
-    - ./Gemfile
-    - ./*.gemspec
   Exclude:
     - ./spec/integration_specs/**/*
     - ./vendor/**/*
     - ./tmp/**/*
+    - ./SourceKitten/**/*
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+
+#- Pending Cops as of 1.22.0 ---------------------------------------------#
+
+Gemspec/DateAssignment: # (new in 1.10)
+  Enabled: true
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousRange: # (new in 1.19)
+  Enabled: true
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+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)
+  Enabled: true
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+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)
+  Enabled: true
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+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)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+Style/HashConversion: # (new in 1.10)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+Style/InPatternThen: # (new in 1.16)
+  Enabled: true
+Style/MultilineInPatternThen: # (new in 1.16)
+  Enabled: true
+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)
+  Enabled: true
 
 # At the moment not ready to be used
 # https://github.com/bbatsov/rubocop/issues/947
-Documentation:
+Style/Documentation:
   Enabled: false
 
 #- Jazzy -----------------------------------------------------------------#
@@ -31,39 +119,40 @@ Metrics/BlockLength:
 Style/NumericPredicate:
   Enabled: false
 
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Enabled: false
 
 # We adopted raise instead of fail.
-SignalException:
+Style/SignalException:
   EnforcedStyle: only_raise
 
 # They are idiomatic
-AssignmentInCondition:
+Lint/AssignmentInCondition:
   Enabled: false
 
 # Allow backticks
-AsciiComments:
+Style/AsciiComments:
   Enabled: false
 
 # Indentation clarifies logic branches in implementations
-IfUnlessModifier:
+Style/IfUnlessModifier:
   Enabled: false
 
 # No enforced convention here.
-SingleLineBlockParams:
+Style/SingleLineBlockParams:
   Enabled: false
 
 # We only add the comment when needed.
-Encoding:
+Style/Encoding:
   Enabled: false
 
 # Having these make it easier to *not* forget to add one when adding a new
 # value and you can simply copy the previous line.
-TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: comma
-
-TrailingCommaInArguments:
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
 
 Style/SpecialGlobalVars:
@@ -78,40 +167,66 @@ Style/TrailingUnderscoreVariable:
 
 # For lambdas nested within certain expressions, this rule forces either ugly
 # parens or curly braces that violate the "do/end for multiline blocks" rule.
-Lambda:
+Style/Lambda:
   Enabled: false
 
 # Disallowing indented "when" clauses destroys readability when using the
 # single-line "when/then" style.
-CaseIndentation:
+Layout/CaseIndentation:
   Enabled: false
 
 # These are both subjective judgements that depend on the situation, and are
 # not appropriate as absolute rules.
-GuardClause:
+Style/GuardClause:
   Enabled: false
-Next:
+Style/Next:
   Enabled: false
 
-RegexpLiteral:
+# Avoid the least-readable varieties of regular expressions.
+Style/RegexpLiteral:
   EnforcedStyle: mixed
 
+# Sometimes easier to read either way
+Style/AccessorGrouping:
+  Enabled: false
+
+# Avoid mandatory wide indentation
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+# Avoid false positives with `Pathname`
+Style/StringConcatenation:
+  Mode: conservative
+
+# Compatibility with earlier Rubocops
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Too much firing on basic arithmetic
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
 #- Jazzy specs -----------------------------------------------------------#
 
 # Allow for `should.match /regexp/`.
-AmbiguousRegexpLiteral:
+Lint/AmbiguousRegexpLiteral:
   Exclude:
     - spec/**/*
 
 # Allow `object.should == object` syntax.
-Void:
+Lint/Void:
   Exclude:
     - spec/**/*
 
-ClassAndModuleChildren:
+Style/ClassAndModuleChildren:
   Exclude:
     - spec/**/*
 
-UselessComparison:
+Lint/BinaryOperatorWithIdenticalOperands:
   Exclude:
     - spec/**/*

data/CHANGELOG.md

@@ -1,3 +1,108 @@
+## 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
+
+* Require at least Ruby 2.6.3.  
+
+##### Enhancements
+
+* Support DocC-style autolinks and callouts in markdown.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Add `--source-host` option to support projects hosted on GitLab and
+  Bitbucket as well as GitHub.  Options `--source-host-url` and
+  `--source-host-files-url` and new Mustache tags replace the 'github' versions
+  which remain as back-compatibility aliases.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#314](https://github.com/realm/jazzy/issues/314)
+
+* Add `rel="noopener"` to all `target="_blank"` links.  
+  [JP Simard](https://github.com/jpsim)
+
+##### Bug Fixes
+
+* Fix source-host line number references in Swift symbolgraph mode, and
+  in ObjC mode for references to one-line declarations.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Fix crash with `` ` ` `` in markdown.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1270](https://github.com/realm/jazzy/issues/1270)
+
+* Fix symbolgraph mode with Xcode 13.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+## 0.13.7
+
+The next release of Jazzy will require a minimum of Ruby 2.6.
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Update JavaScript libraries: jQuery 3.6.0, Lunr 2.3.9,
+  KaTeX 0.13.5.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Support the markdown [footnotes](https://www.markdownguide.org/extended-syntax/#footnotes) extension in all themes.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1246](https://github.com/realm/jazzy/issues/1246)
+
+##### Bug Fixes
+
+* Fix parameter doc comments in Swift symbolgraph mode.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1244](https://github.com/realm/jazzy/issues/1244)
+
+## 0.13.6
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Support documentation generation from `.swiftmodule` binaries using
+  `--swift-build-tool symbolgraph` with Swift 5.3.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Bug Fixes
+
+* Always bypass codesigning when building Xcode projects.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1183](https://github.com/realm/jazzy/issues/1183)
+
 ## 0.13.5
 
 ##### Breaking

data/CONTRIBUTING.md

@@ -13,12 +13,12 @@ the `CHANGELOG.md` file.
 
 We follow the same syntax as CocoaPods' CHANGELOG.md:
 
-1. One Markdown unnumbered list item desribing the change.
-2. 2 trailing spaces on the last line describing the change.
+1. One Markdown unnumbered list item describing the change.
+2. Two trailing spaces on the last line describing the change.
 3. A list of Markdown hyperlinks to the contributors to the change. One entry
-   per line. Usually just one.
+   per line (and there's usually just one contributor).
 4. A list of Markdown hyperlinks to the issues the change addresses. One entry
-   per line. Usually just one. Don't link to PRs here.
+   per line (and there's usually just one hyperlink). Don't link to PRs here.
 5. All CHANGELOG.md content is hard-wrapped at 80 characters.
 
 ## Updating the integration specs
@@ -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 11.4 installed to build the integration specs.
+You must have Xcode 13 installed to build the integration specs.
 
 ## Making changes to SourceKitten
 

data/Dangerfile

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
+
 # Warn when there is a big PR
-warn("Big PR") if git.lines_of_code > 500
+warn('Big PR') if git.lines_of_code > 500
 
 # Don't let testing shortcuts get into master by accident
-(git.modified_files + git.added_files - %w(Dangerfile)).each do |file|
+(git.modified_files + git.added_files - %w[Dangerfile]).each do |file|
   next unless File.file?(file)
+
   contents = File.read(file)
   if file.start_with?('spec')
-    fail("`xit` or `fit` left in tests (#{file})") if contents =~ /^\w*[xf]it/
-    fail("`fdescribe` left in tests (#{file})") if contents =~ /^\w*fdescribe/
+    failure("`xit` or `fit` left in tests (#{file})") if contents =~ /^\w*[xf]it/
+    failure("`fdescribe` left in tests (#{file})") if contents =~ /^\w*fdescribe/
   end
 end
 
@@ -17,12 +20,12 @@ has_app_changes = !git.modified_files.grep(/lib/).empty?
 has_test_changes = !git.modified_files.grep(/spec/).empty?
 
 # Add a CHANGELOG entry for app changes
-if !git.modified_files.include?("CHANGELOG.md") && has_app_changes
-  fail("Please include a CHANGELOG entry. \nYou can find it at [CHANGELOG.md](https://github.com/realm/jazzy/blob/master/CHANGELOG.md).")
-  message "Note, we hard-wrap at 80 chars and use 2 spaces after the last line."
+if !git.modified_files.include?('CHANGELOG.md') && has_app_changes
+  failure "Please include a CHANGELOG entry. \nYou can find it at [CHANGELOG.md](https://github.com/realm/jazzy/blob/master/CHANGELOG.md)."
+  message 'Note, we hard-wrap at 80 chars and use 2 spaces after the last line.'
 end
 
 # Non-trivial amounts of app changes without tests
 if git.lines_of_code > 50 && has_app_changes && !has_test_changes
-    warn "This PR may need tests."
+  warn 'This PR may need tests.'
 end

data/Gemfile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
 group :development do
   # Code style
-  gem 'rubocop', '0.49.0'
+  gem 'rubocop', '~> 1.18'
 
   # Tests
   gem 'bacon'