jazzy 0.9.3 → 0.9.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.circleci/config.yml +3 -3
- data/CHANGELOG.md +24 -0
- data/CONTRIBUTING.md +1 -1
- data/Gemfile.lock +1 -1
- data/README.md +0 -2
- data/lib/jazzy/config.rb +8 -3
- data/lib/jazzy/gem_version.rb +1 -1
- data/lib/jazzy/podspec_documenter.rb +1 -1
- data/lib/jazzy/sourcekitten.rb +7 -4
- data/spec/integration_spec.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f3b6a6bd1f08daea4c0cabeed1607b0c4ab3d70b
|
4
|
+
data.tar.gz: 69b661bafc0c0cb2f19d9fe01b5d483f0f272d2d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0b08613b7a92b0dec87e096e979dbe57882ee7fec15a02afab20788b9f127d273d76fdd60b2288928afa5340b82f5a72ba5910e436a395083f14cb73e5d5c3b4
|
7
|
+
data.tar.gz: 4435f590f247b0dad8f3cbae02727c794a59a3b54595cfa8878c6e8e4c6f6ca59103d286ada3ff35cdd2ffd05575d85718054251526481feb0e7330b12be3a73
|
data/.circleci/config.yml
CHANGED
@@ -23,7 +23,7 @@ jobs:
|
|
23
23
|
|
24
24
|
swift:
|
25
25
|
macos:
|
26
|
-
xcode: "
|
26
|
+
xcode: "10.0.0"
|
27
27
|
environment: *bundler-environment
|
28
28
|
# Used to invoke chruby
|
29
29
|
shell: *shell
|
@@ -38,7 +38,7 @@ jobs:
|
|
38
38
|
|
39
39
|
objc:
|
40
40
|
macos:
|
41
|
-
xcode: "
|
41
|
+
xcode: "10.0.0"
|
42
42
|
environment: *bundler-environment
|
43
43
|
# Used to invoke chruby
|
44
44
|
shell: *shell
|
@@ -53,7 +53,7 @@ jobs:
|
|
53
53
|
|
54
54
|
cocoapods:
|
55
55
|
macos:
|
56
|
-
xcode: "
|
56
|
+
xcode: "10.0.0"
|
57
57
|
environment: *bundler-environment
|
58
58
|
# Used to invoke chruby
|
59
59
|
shell: *shell
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,27 @@
|
|
1
|
+
## 0.9.4
|
2
|
+
|
3
|
+
##### Breaking
|
4
|
+
|
5
|
+
* None.
|
6
|
+
|
7
|
+
##### Enhancements
|
8
|
+
|
9
|
+
* None.
|
10
|
+
|
11
|
+
##### Bug Fixes
|
12
|
+
|
13
|
+
* Fix crash with pre-existing `Docs` directory.
|
14
|
+
[John Fairhurst](https://github.com/johnfairh)
|
15
|
+
[#965](https://github.com/realm/jazzy/issues/965)
|
16
|
+
|
17
|
+
* Fix crash with unicode scalars in string literals.
|
18
|
+
[John Fairhurst](https://github.com/johnfairh)
|
19
|
+
[#972](https://github.com/realm/jazzy/issues/972)
|
20
|
+
|
21
|
+
* Fix error compiling a Swift podspec in Xcode 10.
|
22
|
+
[Minh Nguyễn](https://github.com/1ec5)
|
23
|
+
[#970](https://github.com/realm/jazzy/issues/970)
|
24
|
+
|
1
25
|
## 0.9.3
|
2
26
|
|
3
27
|
##### Breaking
|
data/CONTRIBUTING.md
CHANGED
@@ -49,7 +49,7 @@ git push
|
|
49
49
|
You'll need push access to the integration specs repo to do this. You can
|
50
50
|
request access from one of the maintainers when filing your PR.
|
51
51
|
|
52
|
-
You must have Xcode
|
52
|
+
You must have Xcode 10.0 installed to build the integration specs.
|
53
53
|
|
54
54
|
## Making changes to SourceKitten
|
55
55
|
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -1,7 +1,5 @@
|
|
1
1
|

|
2
2
|
|
3
|
-

|
4
|
-
|
5
3
|
[](https://circleci.com/gh/realm/jazzy)
|
6
4
|
|
7
5
|
*jazzy is a command-line utility that generates documentation for Swift or Objective-C*
|
data/lib/jazzy/config.rb
CHANGED
@@ -86,10 +86,15 @@ module Jazzy
|
|
86
86
|
|
87
87
|
attr_accessor :base_path
|
88
88
|
|
89
|
-
def
|
89
|
+
def expand_glob_path(path)
|
90
90
|
Pathname(path).expand_path(base_path) # nil means Pathname.pwd
|
91
91
|
end
|
92
92
|
|
93
|
+
def expand_path(path)
|
94
|
+
abs_path = expand_glob_path(path)
|
95
|
+
Pathname(Dir[abs_path][0] || abs_path) # Use existing filesystem spelling
|
96
|
+
end
|
97
|
+
|
93
98
|
# ──────── Build ────────
|
94
99
|
|
95
100
|
# rubocop:disable Layout/AlignParameters
|
@@ -164,7 +169,7 @@ module Jazzy
|
|
164
169
|
'Supports wildcards.',
|
165
170
|
default: [],
|
166
171
|
parse: ->(files) do
|
167
|
-
Array(files).map { |f|
|
172
|
+
Array(files).map { |f| expand_glob_path(f).to_s }
|
168
173
|
end
|
169
174
|
|
170
175
|
config_attr :included_files,
|
@@ -173,7 +178,7 @@ module Jazzy
|
|
173
178
|
'Supports wildcards.',
|
174
179
|
default: [],
|
175
180
|
parse: ->(files) do
|
176
|
-
Array(files).map { |f|
|
181
|
+
Array(files).map { |f| expand_glob_path(f).to_s }
|
177
182
|
end
|
178
183
|
|
179
184
|
config_attr :swift_version,
|
data/lib/jazzy/gem_version.rb
CHANGED
@@ -28,7 +28,7 @@ module Jazzy
|
|
28
28
|
targets.map do |t|
|
29
29
|
args = %W[doc --module-name #{podspec.module_name} -- -target #{t}]
|
30
30
|
swift_version = (config.swift_version || '4')[0] + '.0'
|
31
|
-
args << "SWIFT_VERSION
|
31
|
+
args << "SWIFT_VERSION=#{swift_version}"
|
32
32
|
SourceKitten.run_sourcekitten(args)
|
33
33
|
end
|
34
34
|
end
|
data/lib/jazzy/sourcekitten.rb
CHANGED
@@ -339,6 +339,8 @@ module Jazzy
|
|
339
339
|
def self.xml_to_text(xml)
|
340
340
|
document = REXML::Document.new(xml)
|
341
341
|
REXML::XPath.match(document.root, '//text()').map(&:value).join
|
342
|
+
rescue
|
343
|
+
''
|
342
344
|
end
|
343
345
|
|
344
346
|
# Regexp to match an @attribute. Complex to handle @available().
|
@@ -372,10 +374,11 @@ module Jazzy
|
|
372
374
|
end
|
373
375
|
|
374
376
|
def self.prefer_parsed_decl?(parsed, annotated)
|
375
|
-
|
376
|
-
|
377
|
-
|
378
|
-
|
377
|
+
annotated.empty? ||
|
378
|
+
parsed &&
|
379
|
+
(annotated.include?(' = default') || # SR-2608
|
380
|
+
parsed.match('@autoclosure|@escaping') || # SR-6321
|
381
|
+
parsed.include?("\n"))
|
379
382
|
end
|
380
383
|
|
381
384
|
# Replace the fully qualified name of a type with its base name
|
data/spec/integration_spec.rb
CHANGED
@@ -175,7 +175,7 @@ describe_cli 'jazzy' do
|
|
175
175
|
behaves_like cli_spec 'document_alamofire',
|
176
176
|
'-m Alamofire -a Alamofire ' \
|
177
177
|
'-u https://nshipster.com/alamofire ' \
|
178
|
-
'-x -project,Alamofire.xcodeproj
|
178
|
+
'-x -project,Alamofire.xcodeproj ' \
|
179
179
|
'-g https://github.com/Alamofire/Alamofire ' \
|
180
180
|
'--github-file-prefix https://github.com/' \
|
181
181
|
'Alamofire/Alamofire/blob/4.3.0 ' \
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: jazzy
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.9.
|
4
|
+
version: 0.9.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- JP Simard
|
@@ -10,7 +10,7 @@ authors:
|
|
10
10
|
autorequire:
|
11
11
|
bindir: bin
|
12
12
|
cert_chain: []
|
13
|
-
date: 2018-
|
13
|
+
date: 2018-11-01 00:00:00.000000000 Z
|
14
14
|
dependencies:
|
15
15
|
- !ruby/object:Gem::Dependency
|
16
16
|
name: cocoapods
|
@@ -278,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
278
278
|
version: '0'
|
279
279
|
requirements: []
|
280
280
|
rubyforge_project:
|
281
|
-
rubygems_version: 2.6.
|
281
|
+
rubygems_version: 2.6.14.3
|
282
282
|
signing_key:
|
283
283
|
specification_version: 4
|
284
284
|
summary: Soulful docs for Swift & Objective-C.
|