jazzy 0.14.2 → 0.14.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/Tests.yml +7 -7
- data/.rubocop.yml +91 -2
- data/CHANGELOG.md +52 -0
- data/CONTRIBUTING.md +1 -1
- data/Gemfile +1 -1
- data/Gemfile.lock +78 -84
- data/README.md +86 -14
- data/Rakefile +1 -1
- data/bin/sourcekitten +0 -0
- data/jazzy.gemspec +1 -1
- data/js/package-lock.json +33 -17
- data/js/package.json +2 -2
- data/lib/jazzy/config.rb +38 -38
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/katex.min.css +1 -1
- data/lib/jazzy/extensions/katex/js/katex.min.js +1 -1
- data/lib/jazzy/gem_version.rb +1 -1
- data/lib/jazzy/search_builder.rb +1 -1
- data/lib/jazzy/source_declaration/access_control_level.rb +52 -64
- data/lib/jazzy/source_declaration/type.rb +4 -0
- data/lib/jazzy/sourcekitten.rb +16 -1
- data/lib/jazzy/stats.rb +1 -1
- data/lib/jazzy/symbol_graph/constraint.rb +6 -1
- data/lib/jazzy/symbol_graph/graph.rb +1 -1
- data/lib/jazzy/symbol_graph/symbol.rb +2 -1
- data/lib/jazzy/symbol_graph.rb +3 -3
- data/lib/jazzy/themes/apple/assets/js/jquery.min.js +2 -2
- data/lib/jazzy/themes/fullwidth/assets/js/jquery.min.js +2 -2
- data/lib/jazzy/themes/jony/assets/js/jquery.min.js +2 -2
- data/spec/Moya.podspec +55 -0
- data/spec/integration_spec.rb +28 -9
- metadata +6 -5
data/spec/integration_spec.rb
CHANGED
@@ -46,7 +46,7 @@ $:.unshift((ROOT + 'spec').to_s)
|
|
46
46
|
require 'rubygems'
|
47
47
|
require 'bundler/setup'
|
48
48
|
require 'pretty_bacon'
|
49
|
-
require '
|
49
|
+
require 'colored2'
|
50
50
|
require 'CLIntegracon'
|
51
51
|
|
52
52
|
require 'cocoapods'
|
@@ -66,8 +66,8 @@ CLIntegracon.configure do |c|
|
|
66
66
|
# Ignore certain OSX files
|
67
67
|
c.ignores '.DS_Store'
|
68
68
|
c.ignores '.git'
|
69
|
-
c.ignores %r{^(?!((api-)?docs
|
70
|
-
c.ignores '
|
69
|
+
c.ignores %r{^(?!((api-)?docs(/|\z)|execution_output.txt))}
|
70
|
+
c.ignores '**/*.tgz'
|
71
71
|
|
72
72
|
# Remove absolute paths from output
|
73
73
|
c.transform_produced '**/undocumented.json' do |path|
|
@@ -79,6 +79,9 @@ CLIntegracon.configure do |c|
|
|
79
79
|
).gsub(
|
80
80
|
c.spec_path.to_s,
|
81
81
|
'<SPEC>',
|
82
|
+
).gsub(
|
83
|
+
'/transformed',
|
84
|
+
'',
|
82
85
|
),
|
83
86
|
)
|
84
87
|
end
|
@@ -108,8 +111,16 @@ describe_cli 'jazzy' do
|
|
108
111
|
s.replace_path ROOT.to_s, 'ROOT'
|
109
112
|
s.replace_pattern /^[\d\s:.-]+ ruby\[\d+:\d+\] warning:.*$\n?/, ''
|
110
113
|
# Remove version numbers from CocoaPods dependencies
|
111
|
-
# to make specs resilient against
|
114
|
+
# to make specs resilient against dependency updates.
|
112
115
|
s.replace_pattern(/(Installing \w+ )\((.*)\)/, '\1(X.Y.Z)')
|
116
|
+
# Xcode 13.3 etc workaround
|
117
|
+
s.replace_pattern(/202[\d.:\- ]+xcodebuild.*?\n/, '')
|
118
|
+
# Xcode 14 / in-proc sourcekitd workaround
|
119
|
+
s.replace_pattern(/<unknown>:0: remark.*?\n/, '')
|
120
|
+
# CLIntegracon 0.8
|
121
|
+
s.replace_pattern(%r{/transformed/}, '/')
|
122
|
+
# Xcode 15 workaround
|
123
|
+
s.replace_pattern(/objc\[.....\]: Class _?DTX\w+ is implemented in both.*?\n/, '')
|
113
124
|
end
|
114
125
|
|
115
126
|
require 'shellwords'
|
@@ -133,7 +144,7 @@ describe_cli 'jazzy' do
|
|
133
144
|
</script>
|
134
145
|
HTML
|
135
146
|
|
136
|
-
spec_subset = ENV
|
147
|
+
spec_subset = ENV.fetch('JAZZY_SPEC_SUBSET', nil)
|
137
148
|
|
138
149
|
# rubocop:disable Style/MultilineIfModifier
|
139
150
|
|
@@ -178,7 +189,7 @@ describe_cli 'jazzy' do
|
|
178
189
|
end
|
179
190
|
|
180
191
|
behaves_like cli_spec 'misc_jazzy_objc_features',
|
181
|
-
'--theme fullwidth '\
|
192
|
+
'--theme fullwidth ' \
|
182
193
|
'-s objc.json,swift.json'
|
183
194
|
end
|
184
195
|
end if !spec_subset || spec_subset == 'objc'
|
@@ -228,11 +239,11 @@ describe_cli 'jazzy' do
|
|
228
239
|
end
|
229
240
|
|
230
241
|
describe 'Creates docs for Swift project from a .swiftmodule' do
|
231
|
-
build_path = Dir.getwd + 'tmp/.build'
|
242
|
+
build_path = Dir.getwd + '/tmp/.build'
|
232
243
|
package_path =
|
233
244
|
ROOT + 'spec/integration_specs/misc_jazzy_symgraph_features/before'
|
234
|
-
`swift build --package-path #{package_path} --
|
235
|
-
module_path = `swift build --
|
245
|
+
`swift build --package-path #{package_path} --scratch-path #{build_path}`
|
246
|
+
module_path = `swift build --scratch-path #{build_path} --show-bin-path`
|
236
247
|
behaves_like cli_spec 'misc_jazzy_symgraph_features',
|
237
248
|
'--swift-build-tool symbolgraph ' \
|
238
249
|
"--build-tool-arguments -I,#{module_path} "
|
@@ -240,11 +251,19 @@ describe_cli 'jazzy' do
|
|
240
251
|
end if !spec_subset || spec_subset == 'swift'
|
241
252
|
|
242
253
|
describe 'jazzy cocoapods' do
|
254
|
+
# Xcode 14.3 workaround, special podspec
|
255
|
+
podspec_patch = ROOT + 'spec/Moya.podspec'
|
256
|
+
podspec_used = ROOT + 'spec/integration_specs/document_moya_podspec/before/Moya.podspec'
|
257
|
+
podspec_save = ROOT + 'spec/Moya.podspec.safe'
|
258
|
+
FileUtils.cp_r podspec_used, podspec_save, remove_destination: true
|
259
|
+
FileUtils.cp_r podspec_patch, podspec_used, remove_destination: true
|
243
260
|
configure_cocoapods
|
244
261
|
describe 'Creates docs for a podspec with dependencies and subspecs' do
|
245
262
|
behaves_like cli_spec 'document_moya_podspec',
|
246
263
|
'--podspec=Moya.podspec'
|
247
264
|
end
|
265
|
+
FileUtils.cp_r podspec_save, podspec_used, remove_destination: true
|
266
|
+
FileUtils.rm_rf podspec_save
|
248
267
|
end if !spec_subset || spec_subset == 'cocoapods'
|
249
268
|
|
250
269
|
# rubocop:enable Style/MultilineIfModifier
|
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.14.
|
4
|
+
version: 0.14.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- JP Simard
|
@@ -11,7 +11,7 @@ authors:
|
|
11
11
|
autorequire:
|
12
12
|
bindir: bin
|
13
13
|
cert_chain: []
|
14
|
-
date:
|
14
|
+
date: 2023-09-18 00:00:00.000000000 Z
|
15
15
|
dependencies:
|
16
16
|
- !ruby/object:Gem::Dependency
|
17
17
|
name: cocoapods
|
@@ -92,7 +92,7 @@ dependencies:
|
|
92
92
|
version: 2.0.6
|
93
93
|
- - "<"
|
94
94
|
- !ruby/object:Gem::Version
|
95
|
-
version: '
|
95
|
+
version: '5.0'
|
96
96
|
type: :runtime
|
97
97
|
prerelease: false
|
98
98
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -102,7 +102,7 @@ dependencies:
|
|
102
102
|
version: 2.0.6
|
103
103
|
- - "<"
|
104
104
|
- !ruby/object:Gem::Version
|
105
|
-
version: '
|
105
|
+
version: '5.0'
|
106
106
|
- !ruby/object:Gem::Dependency
|
107
107
|
name: sassc
|
108
108
|
requirement: !ruby/object:Gem::Requirement
|
@@ -349,6 +349,7 @@ files:
|
|
349
349
|
- lib/jazzy/themes/jony/templates/parameter.mustache
|
350
350
|
- lib/jazzy/themes/jony/templates/task.mustache
|
351
351
|
- lib/jazzy/themes/jony/templates/tasks.mustache
|
352
|
+
- spec/Moya.podspec
|
352
353
|
- spec/integration_spec.rb
|
353
354
|
- spec/spec_helper.rb
|
354
355
|
- spec/spec_helper/pre_flight.rb
|
@@ -372,7 +373,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
372
373
|
- !ruby/object:Gem::Version
|
373
374
|
version: '0'
|
374
375
|
requirements: []
|
375
|
-
rubygems_version: 3.1
|
376
|
+
rubygems_version: 3.4.1
|
376
377
|
signing_key:
|
377
378
|
specification_version: 4
|
378
379
|
summary: Soulful docs for Swift & Objective-C.
|