jazzy 0.9.3 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: accd6c9ed649bd4be1a4bbc78ad1d0bce7c426de
-  data.tar.gz: 7b3d85bc26cef54041f0b9536e9273f283e952d6
+  metadata.gz: f5a0f16d2a7503e43f28a7eff101228617d44ed4
+  data.tar.gz: e423b906a68d413d3c8e63ce0c7961b5e88da272
 SHA512:
-  metadata.gz: f738c74fb08575c110f13407de425ad988b582f56798fa09899a8e87735c62d966faf4e519eeae349a97393ee69b6c8ece48b1a2df3c2fc9623976dc4d1289d1
-  data.tar.gz: 77fd0c7d2d0ca3af3c284c04c1789747bff4e1dee6c7dfa567092bd3539ee3a1f9e67bf2438bda43f96aa572c4374ac21534006fb17b2df72f54984eaa171dfb
+  metadata.gz: ceff92f660c07d63dfd1bf95c6b9928c7ab56fbe8ec8899d37d275248510d2a79c691fc8c83cdb5dfe5516926009ddd10162c48e74898a37613be2cbfd043299
+  data.tar.gz: 21f47afdaadb40618d31c8b0597c698688adc7c2cd64a152d58d3feea0cf47e5607720ac743730bb5b9191cd970c8fdfb63c5270b8775fe6754e813e04a06985

data/.circleci/config.yml

@@ -23,7 +23,7 @@ jobs:
 
   swift:
     macos:
-      xcode: "9.3.0"
+      xcode: "10.0.0"
     environment: *bundler-environment
     # Used to invoke chruby
     shell: *shell
@@ -38,7 +38,7 @@ jobs:
 
   objc:
     macos:
-      xcode: "9.3.0"
+      xcode: "10.0.0"
     environment: *bundler-environment
     # Used to invoke chruby
     shell: *shell
@@ -53,7 +53,7 @@ jobs:
 
   cocoapods:
     macos:
-      xcode: "9.3.0"
+      xcode: "10.0.0"
     environment: *bundler-environment
     # Used to invoke chruby
     shell: *shell

data/CHANGELOG.md

@@ -1,3 +1,55 @@
+## 0.9.5
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Link to documentation pages from contents pages.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#730](https://github.com/realm/jazzy/issues/730)
+
+* Call out unavailable and deprecated Objective-C declarations.  
+  [Stefan Kieleithner](https://github.com/steviki)
+  [John Fairhurst](https://github.com/johnfairh)
+  [#843](https://github.com/realm/jazzy/issues/843)
+
+##### Bug Fixes
+
+* Support Swift 4.2 with `--podspec`.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1015](https://github.com/realm/jazzy/issues/1015)
+
+* Fix multiline copyright for `apple` theme.  
+  [Fabien Lydoire](https://github.com/fabienlydoire)
+  [John Fairhurst](https://github.com/johnfairh)
+  [#1016](https://github.com/realm/jazzy/issues/1016)
+
+## 0.9.4
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* None.
+
+##### Bug Fixes
+
+* Fix crash with pre-existing `Docs` directory.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#965](https://github.com/realm/jazzy/issues/965)
+
+* Fix crash with unicode scalars in string literals.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#972](https://github.com/realm/jazzy/issues/972)
+
+* Fix error compiling a Swift podspec in Xcode 10.  
+  [Minh Nguyễn](https://github.com/1ec5)
+  [#970](https://github.com/realm/jazzy/issues/970)
+
 ## 0.9.3
 
 ##### 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 9.3 installed to build the integration specs.
+You must have Xcode 10.0 installed to build the integration specs.
 
 ## Making changes to SourceKitten
 

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    jazzy (0.9.3)
-      cocoapods (~> 1.0)
-      mustache (~> 0.99)
+    jazzy (0.9.5)
+      cocoapods (~> 1.5.3)
+      mustache (~> 1.1.0)
       open4
-      redcarpet (~> 3.2)
+      redcarpet (~> 3.4.0)
       rouge (>= 2.0.6, < 4.0)
-      sass (~> 3.4)
-      sqlite3 (~> 1.3)
+      sass (~> 3.6.0)
+      sqlite3 (~> 1.3.13)
       xcinvoke (~> 0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     CFPropertyList (3.0.0)
-    activesupport (4.2.10)
+    activesupport (4.2.11)
       i18n (~> 0.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
@@ -23,7 +23,7 @@ GEM
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
-    atomos (0.1.2)
+    atomos (0.1.3)
     bacon (1.2.0)
     claide (1.0.2)
     claide-plugins (0.9.2)
@@ -33,10 +33,10 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.5.0)
+    cocoapods (1.5.3)
       activesupport (>= 4.0.2, < 5)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.5.0)
+      cocoapods-core (= 1.5.3)
       cocoapods-deintegrate (>= 1.0.2, < 2.0)
       cocoapods-downloader (>= 1.2.0, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -52,86 +52,86 @@ GEM
       nap (~> 1.0)
       ruby-macho (~> 1.1)
       xcodeproj (>= 1.5.7, < 2.0)
-    cocoapods-core (1.5.0)
+    cocoapods-core (1.5.3)
       activesupport (>= 4.0.2, < 6)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
     cocoapods-deintegrate (1.0.2)
-    cocoapods-downloader (1.2.0)
+    cocoapods-downloader (1.2.2)
     cocoapods-plugins (1.0.0)
       nap
     cocoapods-search (1.0.0)
-    cocoapods-stats (1.0.0)
-    cocoapods-trunk (1.3.0)
+    cocoapods-stats (1.1.0)
+    cocoapods-trunk (1.3.1)
       nap (>= 0.8, < 2.0)
       netrc (~> 0.11)
     cocoapods-try (1.1.0)
     colored (1.2)
     colored2 (3.1.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.4)
     cork (0.3.0)
       colored2 (~> 3.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    danger (5.5.12)
+    danger (5.11.1)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
       faraday (~> 0.9)
       faraday-http-cache (~> 1.0)
-      git (~> 1)
+      git (~> 1.5)
       kramdown (~> 1.5)
       no_proxy_fix
       octokit (~> 4.7)
       terminal-table (~> 1)
-    diffy (3.2.0)
+    diffy (3.3.0)
     escape (0.0.4)
-    faraday (0.15.0)
+    faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     faraday-http-cache (1.3.1)
       faraday (~> 0.8)
-    ffi (1.9.23)
+    ffi (1.10.0)
     fourflusher (2.0.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    git (1.3.0)
-    hashdiff (0.3.7)
+    git (1.5.0)
+    hashdiff (0.3.8)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    kramdown (1.16.2)
+    kramdown (1.17.0)
     liferaft (0.0.6)
     metaclass (0.0.4)
     minitest (5.11.3)
-    mocha (1.5.0)
+    mocha (1.8.0)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
-    molinillo (0.6.5)
+    molinillo (0.6.6)
     multipart-post (2.0.0)
-    mustache (0.99.8)
-    nanaimo (0.2.5)
+    mustache (1.1.0)
+    nanaimo (0.2.6)
     nap (1.1.0)
     netrc (0.11.0)
     no_proxy_fix (0.1.2)
-    octokit (4.8.0)
+    octokit (4.13.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.12.1)
-    parser (2.5.1.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
+    powerpack (0.1.2)
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    public_suffix (3.0.2)
+    public_suffix (3.0.3)
     rainbow (2.2.2)
       rake
     rake (10.5.0)
     rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     redcarpet (3.4.0)
-    rouge (3.1.1)
+    rouge (3.3.0)
     rubocop (0.49.0)
       parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
@@ -139,10 +139,10 @@ GEM
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-macho (1.1.0)
-    ruby-progressbar (1.9.0)
+    ruby-macho (1.3.1)
+    ruby-progressbar (1.10.0)
     safe_yaml (1.0.4)
-    sass (3.5.6)
+    sass (3.6.0)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -156,19 +156,19 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.3.2)
-    webmock (3.3.0)
+    unicode-display_width (1.4.1)
+    webmock (3.5.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.5.7)
+    xcodeproj (1.7.0)
       CFPropertyList (>= 2.3.3, < 4.0)
-      atomos (~> 0.1.2)
+      atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)
       colored2 (~> 3.1)
-      nanaimo (~> 0.2.4)
+      nanaimo (~> 0.2.6)
 
 PLATFORMS
   ruby
@@ -188,4 +188,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.16.0
+   1.17.3

data/README.md

@@ -1,7 +1,5 @@
 ![jazzy](images/logo.jpg)
 
-![analytics](https://ga-beacon.appspot.com/UA-50247013-2/jazzy/README?pixel)
-
 [![Build Status](https://circleci.com/gh/realm/jazzy.svg?style=svg)](https://circleci.com/gh/realm/jazzy)
 
 *jazzy is a command-line utility that generates documentation for Swift or Objective-C*
@@ -35,9 +33,8 @@ document. It must be installed in a location indexed by Spotlight for the
 [sudo] gem install jazzy
 ```
 
-The Xcode command-line developer tools must be installed to successfully build
-the gems that `jazzy` depends on: try `xcode-select --install` if you see build
-errors.
+See [Installation Problems](#installation-problems) for solutions to some
+common problems.
 
 ## Usage
 
@@ -168,7 +165,7 @@ Any files found matching the file pattern will be parsed and included as a docum
 
 There are a few limitations:
 - File names must be unique from source files.
-- Readme should be specified separately using the `readme_path` option.
+- Readme should be specified separately using the `readme` option.
 
 ### Section description abstracts
 
@@ -222,6 +219,20 @@ Note that the `--include` option is applied before the `--exclude` option. For e
 Declarations with a documentation comment containing `:nodoc:` are excluded from the
 documentation.
 
+### Choosing the Swift language version
+
+Jazzy normally uses the Swift compiler from the Xcode currently configured by
+`xcode-select`.  Use the `--swift-version` flag to compile with a different
+Xcode.
+
+The value you pass to `--swift-version` must be the Swift language version given
+by `swift --version` in the Xcode you want to use.
+
+For example to use Xcode 9.4:
+```shell
+jazzy --swift-version 4.1.2
+```
+
 ## Troubleshooting
 
 #### Swift
@@ -230,6 +241,33 @@ documentation.
 
 Check the `--min-acl` setting -- see [above](#controlling-what-is-documented).
 
+**Unable to find an Xcode with swift version X**
+
+1. The value passed with `--swift-version` must exactly match the version
+   number from `swiftc --version`.  For example Xcode 10.1 needs
+   `--swift-version 4.2.1`.  See [the flag documentation](#choosing-the-swift-language-version).
+2. The Xcode you want to use must be in the Spotlight index.  You can check
+   this using `mdfind 'kMDItemCFBundleIdentifier == com.apple.dt.Xcode'`.
+   Some users have reported this issue being fixed by a reboot; `mdutil -E`
+   may also help.  If none of these work then you can set the `DEVELOPER_DIR`
+   environment variable to point to the Xcode you want before running Jazzy
+   without the `--swift-version` flag.
+
+#### Installation Problems
+
+**Can't find header files / clang**
+
+Some of the Ruby gems that Jazzy depends on have native C extensions.  This
+means you need the Xcode command-line developer tools installed to build
+them: run `xcode-select --install` to install the tools.
+
+**/Applications/Xcode: No such file or directory**
+
+The path of your active Xcode installation must not contain spaces.  So
+`/Applications/Xcode.app/` is fine, `/Applications/Xcode-10.2.app/` is fine,
+but `/Applications/Xcode 10.2.app/` is not.  This restriction applies only
+when *installing* Jazzy, not running it.
+
 ## Development
 
 Please review jazzy's [contributing guidelines](https://github.com/realm/jazzy/blob/master/CONTRIBUTING.md) when submitting pull requests.

data/jazzy.gemspec

@@ -17,13 +17,13 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split($/)
   spec.executables   << 'jazzy'
 
-  spec.add_runtime_dependency 'cocoapods', '~> 1.0'
-  spec.add_runtime_dependency 'mustache', '~> 0.99'
+  spec.add_runtime_dependency 'cocoapods', '~> 1.5.3'
+  spec.add_runtime_dependency 'mustache', '~> 1.1.0'
   spec.add_runtime_dependency 'open4'
-  spec.add_runtime_dependency 'redcarpet', '~> 3.2'
+  spec.add_runtime_dependency 'redcarpet', '~> 3.4.0'
   spec.add_runtime_dependency 'rouge', ['>= 2.0.6', '< 4.0']
-  spec.add_runtime_dependency 'sass', '~> 3.4'
-  spec.add_runtime_dependency 'sqlite3', '~> 1.3'
+  spec.add_runtime_dependency 'sass', '~> 3.6.0'
+  spec.add_runtime_dependency 'sqlite3', '~> 1.3.13'
   spec.add_runtime_dependency 'xcinvoke', '~> 0.3.0'
 
   spec.add_development_dependency 'bundler', '~> 1.7'

data/lib/jazzy/config.rb

@@ -86,10 +86,15 @@ module Jazzy
 
     attr_accessor :base_path
 
-    def expand_path(path)
+    def expand_glob_path(path)
       Pathname(path).expand_path(base_path) # nil means Pathname.pwd
     end
 
+    def expand_path(path)
+      abs_path = expand_glob_path(path)
+      Pathname(Dir[abs_path][0] || abs_path) # Use existing filesystem spelling
+    end
+
     # ──────── Build ────────
 
     # rubocop:disable Layout/AlignParameters
@@ -164,7 +169,7 @@ module Jazzy
                    'Supports wildcards.',
       default: [],
       parse: ->(files) do
-        Array(files).map { |f| expand_path(f).to_s }
+        Array(files).map { |f| expand_glob_path(f).to_s }
       end
 
     config_attr :included_files,
@@ -173,7 +178,7 @@ module Jazzy
                    'Supports wildcards.',
       default: [],
       parse: ->(files) do
-        Array(files).map { |f| expand_path(f).to_s }
+        Array(files).map { |f| expand_glob_path(f).to_s }
       end
 
     config_attr :swift_version,