jazzy 0.15.0 → 0.15.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +6 -0
- data/CHANGELOG.md +16 -0
- data/Gemfile.lock +19 -17
- data/jazzy.gemspec +1 -1
- data/lib/jazzy/config.rb +2 -2
- data/lib/jazzy/gem_version.rb +1 -1
- data/lib/jazzy/grouper.rb +6 -6
- data/lib/jazzy/sourcekitten.rb +6 -4
- metadata +13 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 233b49769d27b199b20651cff4041041fda0c9506945290fea84937ee5f1723f
|
4
|
+
data.tar.gz: 55148a0bff106913b60dd295851d069a8aa344a21c2b52e3453d1bbeebd2a8ad
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f093b513515728c93ffce07528fe6042d05063b8b9b78e4283f89f9e41632a06509434bc3f533f2b4e1d9f30619cde090acff726a1463ea61669091f56734f41
|
7
|
+
data.tar.gz: 36ba08e16c04d207568ce01f1e864bee4d495197cdf14bbc643d714e3ea85aeff2c9c102e4baa7122916f49dbf2d3e77dcf59ecebfd4a9c1839b5eb9bf18e08d
|
data/.rubocop.yml
CHANGED
@@ -10,6 +10,8 @@ AllCops:
|
|
10
10
|
|
11
11
|
#- Pending Cops as of 1.56.3 ---------------------------------------------#
|
12
12
|
|
13
|
+
|
14
|
+
|
13
15
|
Gemspec/DeprecatedAttributeAssignment: # new in 1.30
|
14
16
|
Enabled: true
|
15
17
|
Gemspec/DevelopmentDependencies: # new in 1.44
|
@@ -200,10 +202,14 @@ Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
|
|
200
202
|
Enabled: true
|
201
203
|
Style/SelectByRegexp: # new in 1.22
|
202
204
|
Enabled: true
|
205
|
+
Style/SendWithLiteralMethodName: # new in 1.64
|
206
|
+
Enabled: true
|
203
207
|
Style/SingleLineDoEndBlock: # new in 1.57
|
204
208
|
Enabled: true
|
205
209
|
Style/StringChars: # (new in 1.12)
|
206
210
|
Enabled: true
|
211
|
+
Style/SuperArguments: # new in 1.64
|
212
|
+
Enabled: true
|
207
213
|
Style/SuperWithArgsParentheses: # new in 1.58
|
208
214
|
Enabled: true
|
209
215
|
Style/SwapValues: # (new in 1.1)
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,19 @@
|
|
1
|
+
## 0.15.1
|
2
|
+
|
3
|
+
##### Breaking
|
4
|
+
|
5
|
+
* None.
|
6
|
+
|
7
|
+
##### Enhancements
|
8
|
+
|
9
|
+
* None.
|
10
|
+
|
11
|
+
##### Bug Fixes
|
12
|
+
|
13
|
+
* Restore compatibility with Ruby 2.6
|
14
|
+
[John Fairhurst](https://github.com/johnfairh)
|
15
|
+
[#1388](https://github.com/realm/jazzy/issues/1388)
|
16
|
+
|
1
17
|
## 0.15.0
|
2
18
|
|
3
19
|
##### Breaking
|
data/Gemfile.lock
CHANGED
@@ -9,12 +9,12 @@ GIT
|
|
9
9
|
PATH
|
10
10
|
remote: .
|
11
11
|
specs:
|
12
|
-
jazzy (0.15.
|
12
|
+
jazzy (0.15.1)
|
13
13
|
cocoapods (~> 1.5)
|
14
14
|
mustache (~> 1.1)
|
15
15
|
open4 (~> 1.3)
|
16
16
|
redcarpet (~> 3.4)
|
17
|
-
rexml (
|
17
|
+
rexml (>= 3.2.7, < 4.0)
|
18
18
|
rouge (>= 2.0.6, < 5.0)
|
19
19
|
sassc (~> 2.1)
|
20
20
|
sqlite3 (~> 1.3)
|
@@ -27,7 +27,7 @@ GEM
|
|
27
27
|
base64
|
28
28
|
nkf
|
29
29
|
rexml
|
30
|
-
activesupport (7.1.3.
|
30
|
+
activesupport (7.1.3.4)
|
31
31
|
base64
|
32
32
|
bigdecimal
|
33
33
|
concurrent-ruby (~> 1.0, >= 1.0.2)
|
@@ -46,7 +46,7 @@ GEM
|
|
46
46
|
atomos (0.1.3)
|
47
47
|
bacon (1.2.0)
|
48
48
|
base64 (0.2.0)
|
49
|
-
bigdecimal (3.1.
|
49
|
+
bigdecimal (3.1.8)
|
50
50
|
claide (1.1.0)
|
51
51
|
claide-plugins (0.9.2)
|
52
52
|
cork
|
@@ -90,7 +90,7 @@ GEM
|
|
90
90
|
netrc (~> 0.11)
|
91
91
|
cocoapods-try (1.2.0)
|
92
92
|
colored2 (3.1.2)
|
93
|
-
concurrent-ruby (1.2
|
93
|
+
concurrent-ruby (1.3.2)
|
94
94
|
connection_pool (2.4.1)
|
95
95
|
cork (0.3.0)
|
96
96
|
colored2 (~> 3.1)
|
@@ -115,13 +115,13 @@ GEM
|
|
115
115
|
escape (0.0.4)
|
116
116
|
ethon (0.16.0)
|
117
117
|
ffi (>= 1.15.0)
|
118
|
-
faraday (2.9.
|
118
|
+
faraday (2.9.1)
|
119
119
|
faraday-net_http (>= 2.0, < 3.2)
|
120
120
|
faraday-http-cache (2.5.1)
|
121
121
|
faraday (>= 0.8)
|
122
122
|
faraday-net_http (3.1.0)
|
123
123
|
net-http
|
124
|
-
ffi (1.
|
124
|
+
ffi (1.17.0)
|
125
125
|
fourflusher (2.3.1)
|
126
126
|
fuzzy_match (2.0.4)
|
127
127
|
gh_inspector (1.1.3)
|
@@ -130,7 +130,7 @@ GEM
|
|
130
130
|
rchardet (~> 1.8)
|
131
131
|
hashdiff (1.1.0)
|
132
132
|
httpclient (2.8.3)
|
133
|
-
i18n (1.14.
|
133
|
+
i18n (1.14.5)
|
134
134
|
concurrent-ruby (~> 1.0)
|
135
135
|
json (2.7.2)
|
136
136
|
kramdown (2.4.0)
|
@@ -139,9 +139,9 @@ GEM
|
|
139
139
|
kramdown (~> 2.0)
|
140
140
|
language_server-protocol (3.17.0.3)
|
141
141
|
liferaft (0.0.6)
|
142
|
-
mini_portile2 (2.8.
|
143
|
-
minitest (5.
|
144
|
-
mocha (2.
|
142
|
+
mini_portile2 (2.8.7)
|
143
|
+
minitest (5.23.1)
|
144
|
+
mocha (2.3.0)
|
145
145
|
ruby2_keywords (>= 0.0.5)
|
146
146
|
mocha-on-bacon (0.2.3)
|
147
147
|
mocha (>= 0.13.0)
|
@@ -161,21 +161,22 @@ GEM
|
|
161
161
|
sawyer (~> 0.9)
|
162
162
|
open4 (1.3.4)
|
163
163
|
parallel (1.24.0)
|
164
|
-
parser (3.3.
|
164
|
+
parser (3.3.2.0)
|
165
165
|
ast (~> 2.4.1)
|
166
166
|
racc
|
167
167
|
prettybacon (0.0.2)
|
168
168
|
bacon (~> 1.2)
|
169
169
|
public_suffix (4.0.7)
|
170
|
-
racc (1.
|
170
|
+
racc (1.8.0)
|
171
171
|
rainbow (3.1.1)
|
172
172
|
rake (13.2.1)
|
173
173
|
rchardet (1.8.0)
|
174
174
|
redcarpet (3.6.0)
|
175
|
-
regexp_parser (2.9.
|
176
|
-
rexml (3.2.
|
175
|
+
regexp_parser (2.9.2)
|
176
|
+
rexml (3.2.8)
|
177
|
+
strscan (>= 3.0.9)
|
177
178
|
rouge (4.2.1)
|
178
|
-
rubocop (1.
|
179
|
+
rubocop (1.64.1)
|
179
180
|
json (~> 2.3)
|
180
181
|
language_server-protocol (>= 3.17.0)
|
181
182
|
parallel (~> 1.10)
|
@@ -198,6 +199,7 @@ GEM
|
|
198
199
|
faraday (>= 0.17.3, < 3)
|
199
200
|
sqlite3 (1.7.3)
|
200
201
|
mini_portile2 (~> 2.8.0)
|
202
|
+
strscan (3.1.0)
|
201
203
|
terminal-table (3.0.2)
|
202
204
|
unicode-display_width (>= 1.1.1, < 3)
|
203
205
|
typhoeus (1.4.1)
|
@@ -206,7 +208,7 @@ GEM
|
|
206
208
|
concurrent-ruby (~> 1.0)
|
207
209
|
unicode-display_width (2.5.0)
|
208
210
|
uri (0.13.0)
|
209
|
-
webmock (3.23.
|
211
|
+
webmock (3.23.1)
|
210
212
|
addressable (>= 2.8.0)
|
211
213
|
crack (>= 0.3.2)
|
212
214
|
hashdiff (>= 0.4.0, < 2.0.0)
|
data/jazzy.gemspec
CHANGED
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
|
|
22
22
|
spec.add_runtime_dependency 'mustache', '~> 1.1'
|
23
23
|
spec.add_runtime_dependency 'open4', '~> 1.3'
|
24
24
|
spec.add_runtime_dependency 'redcarpet', '~> 3.4'
|
25
|
-
spec.add_runtime_dependency 'rexml', '
|
25
|
+
spec.add_runtime_dependency 'rexml', ['>= 3.2.7', '< 4.0']
|
26
26
|
spec.add_runtime_dependency 'rouge', ['>= 2.0.6', '< 5.0']
|
27
27
|
spec.add_runtime_dependency 'sassc', '~> 2.1'
|
28
28
|
spec.add_runtime_dependency 'sqlite3', '~> 1.3'
|
data/lib/jazzy/config.rb
CHANGED
@@ -717,12 +717,12 @@ module Jazzy
|
|
717
717
|
|
718
718
|
if modules.first.is_a?(String)
|
719
719
|
# Massage format (2) into (3)
|
720
|
-
self.modules = modules.map { { 'module' =>
|
720
|
+
self.modules = modules.map { |mod| { 'module' => mod } }
|
721
721
|
end
|
722
722
|
|
723
723
|
# Allow per-module overrides of only some config options
|
724
724
|
attrs_by_conf_key, attrs_by_name =
|
725
|
-
grouped_attributes {
|
725
|
+
grouped_attributes { |attr| attr.select(&:per_module) }
|
726
726
|
|
727
727
|
modules.map do |module_hash|
|
728
728
|
mod_name = module_hash['module'] || ''
|
data/lib/jazzy/gem_version.rb
CHANGED
data/lib/jazzy/grouper.rb
CHANGED
@@ -24,7 +24,7 @@ module Jazzy
|
|
24
24
|
# Group root-level docs by type
|
25
25
|
def self.group_docs_by_type(docs, type_category_prefix)
|
26
26
|
type_groups = SourceDeclaration::Type.all.map do |type|
|
27
|
-
children, docs = docs.partition {
|
27
|
+
children, docs = docs.partition { |doc| doc.type == type }
|
28
28
|
make_type_group(children, type, type_category_prefix)
|
29
29
|
end
|
30
30
|
merge_categories(type_groups.compact) + docs
|
@@ -49,7 +49,7 @@ module Jazzy
|
|
49
49
|
|
50
50
|
def self.group_custom_categories(docs, doc_index)
|
51
51
|
group = config.custom_categories.map do |category|
|
52
|
-
children = category['children'].
|
52
|
+
children = category['children'].map do |name|
|
53
53
|
unless doc = doc_index.lookup(name)
|
54
54
|
warn 'WARNING: No documented top-level declarations match ' \
|
55
55
|
"name \"#{name}\" specified in categories file"
|
@@ -64,7 +64,7 @@ module Jazzy
|
|
64
64
|
end
|
65
65
|
|
66
66
|
docs.delete(doc)
|
67
|
-
end
|
67
|
+
end.compact
|
68
68
|
# Category config overrides alphabetization
|
69
69
|
children.each.with_index { |child, i| child.nav_order = i }
|
70
70
|
make_group(children, category['name'], '')
|
@@ -73,7 +73,7 @@ module Jazzy
|
|
73
73
|
end
|
74
74
|
|
75
75
|
def self.group_guides(docs, prefix)
|
76
|
-
guides, others = docs.partition {
|
76
|
+
guides, others = docs.partition { |doc| doc.type.markdown? }
|
77
77
|
return [[], others] unless guides.any?
|
78
78
|
|
79
79
|
[[make_type_group(guides, guides.first.type, prefix)], others]
|
@@ -92,7 +92,7 @@ module Jazzy
|
|
92
92
|
def self.merge_categories(categories)
|
93
93
|
merged = []
|
94
94
|
categories.each do |new_category|
|
95
|
-
if existing = merged.find {
|
95
|
+
if existing = merged.find { |cat| cat.name == new_category.name }
|
96
96
|
existing.children += new_category.children
|
97
97
|
else
|
98
98
|
merged.append(new_category)
|
@@ -102,7 +102,7 @@ module Jazzy
|
|
102
102
|
end
|
103
103
|
|
104
104
|
def self.make_group(group, name, abstract, url_name = nil)
|
105
|
-
group.reject! {
|
105
|
+
group.reject! { |decl| decl.name.empty? }
|
106
106
|
unless group.empty?
|
107
107
|
SourceDeclaration.new.tap do |sd|
|
108
108
|
sd.type = SourceDeclaration::Type.overview
|
data/lib/jazzy/sourcekitten.rb
CHANGED
@@ -692,7 +692,7 @@ module Jazzy
|
|
692
692
|
decl.type.objc_class? ||
|
693
693
|
(decl.type.objc_category? &&
|
694
694
|
(category_classname = decl.objc_category_name[0]) &&
|
695
|
-
root_decls.any? {
|
695
|
+
root_decls.any? { |d| d.name == category_classname })
|
696
696
|
end
|
697
697
|
|
698
698
|
# Returns if a Swift declaration is mergeable.
|
@@ -919,7 +919,9 @@ module Jazzy
|
|
919
919
|
|
920
920
|
# Grab all the extensions from the same doc module
|
921
921
|
def self.next_doc_module_group(decls)
|
922
|
-
decls.partition
|
922
|
+
decls.partition do |decl|
|
923
|
+
decl.doc_module_name == decls.first.doc_module_name
|
924
|
+
end
|
923
925
|
end
|
924
926
|
|
925
927
|
# Does this extension/type need a note explaining which doc module it is from?
|
@@ -1055,12 +1057,12 @@ module Jazzy
|
|
1055
1057
|
# Remove top-level enum cases because it means they have an ACL lower
|
1056
1058
|
# than min_acl
|
1057
1059
|
def self.reject_swift_types(docs)
|
1058
|
-
docs.reject {
|
1060
|
+
docs.reject { |doc| doc.type.swift_enum_element? }
|
1059
1061
|
end
|
1060
1062
|
|
1061
1063
|
# Spot and mark any categories on classes not declared in these docs
|
1062
1064
|
def self.mark_objc_external_categories(docs)
|
1063
|
-
class_names = docs.select {
|
1065
|
+
class_names = docs.select { |doc| doc.type.objc_class? }.to_set(&:name)
|
1064
1066
|
|
1065
1067
|
docs.map do |doc|
|
1066
1068
|
if (names = doc.objc_category_name) && !class_names.include?(names.first)
|
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.15.
|
4
|
+
version: 0.15.1
|
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: 2024-
|
14
|
+
date: 2024-06-08 00:00:00.000000000 Z
|
15
15
|
dependencies:
|
16
16
|
- !ruby/object:Gem::Dependency
|
17
17
|
name: cocoapods
|
@@ -73,16 +73,22 @@ dependencies:
|
|
73
73
|
name: rexml
|
74
74
|
requirement: !ruby/object:Gem::Requirement
|
75
75
|
requirements:
|
76
|
-
- - "
|
76
|
+
- - ">="
|
77
|
+
- !ruby/object:Gem::Version
|
78
|
+
version: 3.2.7
|
79
|
+
- - "<"
|
77
80
|
- !ruby/object:Gem::Version
|
78
|
-
version: '
|
81
|
+
version: '4.0'
|
79
82
|
type: :runtime
|
80
83
|
prerelease: false
|
81
84
|
version_requirements: !ruby/object:Gem::Requirement
|
82
85
|
requirements:
|
83
|
-
- - "
|
86
|
+
- - ">="
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: 3.2.7
|
89
|
+
- - "<"
|
84
90
|
- !ruby/object:Gem::Version
|
85
|
-
version: '
|
91
|
+
version: '4.0'
|
86
92
|
- !ruby/object:Gem::Dependency
|
87
93
|
name: rouge
|
88
94
|
requirement: !ruby/object:Gem::Requirement
|
@@ -376,7 +382,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
376
382
|
- !ruby/object:Gem::Version
|
377
383
|
version: '0'
|
378
384
|
requirements: []
|
379
|
-
rubygems_version: 3.
|
385
|
+
rubygems_version: 3.5.3
|
380
386
|
signing_key:
|
381
387
|
specification_version: 4
|
382
388
|
summary: Soulful docs for Swift & Objective-C.
|