jazzy 0.13.7 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63788e011ffdb57c019f0bd8f06892fbc47303f10d57407e8487e5c4d070c761
-  data.tar.gz: d93e4603a15f4c5695bab995c3fc99fbeb7fd463e97a41806c9e6fa7c563fc05
+  metadata.gz: f6b0e2553b3b64a0b692c79a6d62735a8f2e35d3322fe371bd926f050a8b0850
+  data.tar.gz: df8dd3fb4e80e0c9e69db6ec7f0337c5c9687a90a130bc899748ab789ee56d61
 SHA512:
-  metadata.gz: d73ba88867dcb2f32d7358b367ab24ac086bceccf02aa74e18b2d17e6d70870a4831fbbbfb6027af8a99e4ddc8db737fefbfe60580924a9367d5b11a472b0b12
-  data.tar.gz: 61f9af01c7fd7b2293e9d91cb60063c8fc5e95281815e7a8ff11bc2a80fdbf514264a4d4fada6fc29ad7e97859e18b9d17a3cf2649a1b1f5aa0bd9cb24e22276
+  metadata.gz: b6d2956ca649999f8802d00c59fadd0b5e608a9f46a553c1b5c54cb9d49962d69336fcfe822bde691409770412bf484da4f73cf8405720dbfe24aa6096a9ca60
+  data.tar.gz: 036cb12b85c127721690e88295ac68ed5b25dee219c7c87f5933a20d4e2a285fa75acbc4496a97637f09ca07b4caee193aca783ee73ffdd110a9a02fbe064f00

data/.github/workflows/Tests.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.5
+          ruby-version: 2.6
           bundler-cache: true
       - name: Danger
         env:
@@ -25,7 +25,7 @@ jobs:
           bundle exec rake rubocop
 
   spec:
-    runs-on: macos-11.0
+    runs-on: macos-11
     continue-on-error: true
     strategy:
       matrix:

data/.rubocop.yml

@@ -1,16 +1,92 @@
 AllCops:
-  Include:
-    - ./Rakefile
-    - ./Gemfile
-    - ./*.gemspec
   Exclude:
     - ./spec/integration_specs/**/*
     - ./vendor/**/*
     - ./tmp/**/*
+    - ./SourceKitten/**/*
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+
+#- Pending Cops as of 1.19.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/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/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
+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/QuotedSymbols: # (new in 1.16)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # (new in 1.19)
+  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 +107,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 +155,62 @@ 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
+
 #- 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,37 @@
+## 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.

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'

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    jazzy (0.13.7)
+    jazzy (0.14.0)
       cocoapods (~> 1.5)
       mustache (~> 1.1)
-      open4
+      open4 (~> 1.3)
       redcarpet (~> 3.4)
+      rexml (~> 3.2)
       rouge (>= 2.0.6, < 4.0)
       sassc (~> 2.1)
       sqlite3 (~> 1.3)
@@ -20,7 +21,7 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     algoliasearch (1.27.5)
       httpclient (~> 2.8, >= 2.8.3)
@@ -36,10 +37,10 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.10.1)
+    cocoapods (1.10.2)
       addressable (~> 2.6)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.10.1)
+      cocoapods-core (= 1.10.2)
       cocoapods-deintegrate (>= 1.0.3, < 2.0)
       cocoapods-downloader (>= 1.4.0, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -54,7 +55,7 @@ GEM
       nap (~> 1.0)
       ruby-macho (~> 1.4)
       xcodeproj (>= 1.19.0, < 2.0)
-    cocoapods-core (1.10.1)
+    cocoapods-core (1.10.2)
       activesupport (> 5.0, < 6)
       addressable (~> 2.6)
       algoliasearch (~> 1.0)
@@ -68,19 +69,19 @@ GEM
     cocoapods-downloader (1.4.0)
     cocoapods-plugins (1.0.0)
       nap
-    cocoapods-search (1.0.0)
+    cocoapods-search (1.0.1)
     cocoapods-trunk (1.5.0)
       nap (>= 0.8, < 2.0)
       netrc (~> 0.11)
     cocoapods-try (1.2.0)
     colored (1.2)
     colored2 (3.1.2)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     cork (0.3.0)
       colored2 (~> 3.1)
     crack (0.4.5)
       rexml
-    danger (8.2.3)
+    danger (8.3.1)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -97,22 +98,32 @@ GEM
     escape (0.0.4)
     ethon (0.14.0)
       ffi (>= 1.15.0)
-    faraday (1.4.1)
+    faraday (1.7.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
       faraday-net_http (~> 1.0)
       faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-http-cache (2.2.0)
       faraday (>= 0.8)
+    faraday-httpclient (1.0.1)
     faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.1.0)
-    ffi (1.15.0)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    ffi (1.15.3)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    git (1.8.1)
+    git (1.9.1)
       rchardet (~> 1.8)
     hashdiff (1.0.1)
     httpclient (2.8.3)
@@ -125,7 +136,7 @@ GEM
       kramdown (~> 2.0)
     liferaft (0.0.6)
     minitest (5.14.4)
-    mocha (1.12.0)
+    mocha (1.13.0)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
     molinillo (0.6.6)
@@ -140,62 +151,66 @@ GEM
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
     parallel (1.20.1)
-    parser (2.7.2.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
-    powerpack (0.1.3)
     prettybacon (0.0.2)
       bacon (~> 1.2)
     public_suffix (4.0.6)
-    rainbow (2.2.2)
-      rake
-    rake (13.0.3)
+    rainbow (3.0.0)
+    rake (13.0.6)
     rchardet (1.8.0)
     redcarpet (3.5.1)
+    regexp_parser (2.1.1)
     rexml (3.2.5)
     rouge (3.26.0)
-    rubocop (0.49.0)
+    rubocop (1.19.0)
       parallel (~> 1.10)
-      parser (>= 2.3.3.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      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)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
     ruby-macho (1.4.0)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
+    ruby2_keywords (0.0.5)
     sassc (2.4.0)
       ffi (~> 1.9)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
     sqlite3 (1.4.2)
-    terminal-table (3.0.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
+    terminal-table (3.0.1)
+      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 (1.7.0)
-    webmock (3.12.2)
-      addressable (>= 2.3.6)
+    unicode-display_width (2.0.0)
+    webmock (3.14.0)
+      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.19.0)
+    xcodeproj (1.21.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)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bacon
-  bundler (~> 1.7)
+  bundler (~> 2.1)
   clintegracon (= 0.7.0)
   danger
   diffy
@@ -204,8 +219,8 @@ DEPENDENCIES
   mocha-on-bacon
   prettybacon
   rake (~> 13.0)
-  rubocop (= 0.49.0)
+  rubocop (~> 1.18)
   webmock
 
 BUNDLED WITH
-   1.17.3
+   2.2.22