jazzy 0.1.6 → 0.2.0
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/CHANGELOG.md +25 -0
- data/Gemfile.lock +6 -6
- data/lib/jazzy/SourceKitten/Commandant.framework/Commandant +0 -0
- data/lib/jazzy/SourceKitten/Commandant.framework/Versions/A/Commandant +0 -0
- data/lib/jazzy/SourceKitten/Commandant.framework/Versions/A/Resources/Info.plist +5 -5
- data/lib/jazzy/SourceKitten/LlamaKit.framework/LlamaKit +0 -0
- data/lib/jazzy/SourceKitten/LlamaKit.framework/Versions/A/LlamaKit +0 -0
- data/lib/jazzy/SourceKitten/LlamaKit.framework/Versions/A/Resources/Info.plist +5 -5
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/SourceKittenFramework +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/Resources/Info.plist +45 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/SWXMLHash +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/SwiftXPC +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Resources/Info.plist +6 -6
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/SwiftXPC +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCore.dylib +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCoreGraphics.dylib +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDarwin.dylib +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDispatch.dylib +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftFoundation.dylib +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftObjectiveC.dylib +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftSecurity.dylib +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Resources/Info.plist +6 -6
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/SourceKittenFramework +0 -0
- data/lib/jazzy/SourceKitten/sourcekitten +0 -0
- data/lib/jazzy/config.rb +4 -4
- data/lib/jazzy/gem_version.rb +1 -1
- data/lib/jazzy/source_declaration/access_control_level.rb +35 -7
- data/lib/jazzy/sourcekitten.rb +7 -10
- data/spec/sourcekitten_spec.rb +4 -4
- metadata +6 -16
- data/lib/jazzy/SourceKitten/Commandant.framework/Versions/A/Modules/Commandant.swiftmodule/x86_64.swiftdoc +0 -0
- data/lib/jazzy/SourceKitten/Commandant.framework/Versions/A/Modules/Commandant.swiftmodule/x86_64.swiftmodule +0 -0
- data/lib/jazzy/SourceKitten/Commandant.framework/Versions/A/Modules/module.modulemap +0 -10
- data/lib/jazzy/SourceKitten/LlamaKit.framework/Versions/A/Modules/LlamaKit.swiftmodule/x86_64.swiftdoc +0 -0
- data/lib/jazzy/SourceKitten/LlamaKit.framework/Versions/A/Modules/LlamaKit.swiftmodule/x86_64.swiftmodule +0 -0
- data/lib/jazzy/SourceKitten/LlamaKit.framework/Versions/A/Modules/module.modulemap +0 -10
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Modules/SwiftXPC.swiftmodule/x86_64.swiftdoc +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Modules/SwiftXPC.swiftmodule/x86_64.swiftmodule +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Modules/module.modulemap +0 -10
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Modules/SourceKittenFramework.swiftmodule/x86_64.swiftdoc +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Modules/SourceKittenFramework.swiftmodule/x86_64.swiftmodule +0 -0
- data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Modules/module.modulemap +0 -10
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d06338c65161e748c8e95e6fe8b9270101f5edc6
|
|
4
|
+
data.tar.gz: 7cc9150d00cb56fd6139df4b3ed0ecd8abe310bd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5de22817988a276354c66ad51274dd0f61e86f2ce8ae3020d4e85313d16d325ecc5e1f941bf846d42dc8819f2644aa213a5e80ab7b2cc69608f499d069e73fe5
|
|
7
|
+
data.tar.gz: 0f832259dadb561daeebeaf7967114b17e821a5021e04eb012db9a6ba46afbb12c5677bf41bc9a1843411ab70aee77d061dd41cea8f33c8690c88b8c7edd15fd
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,28 @@
|
|
|
1
|
+
## 0.2.0
|
|
2
|
+
|
|
3
|
+
##### Breaking
|
|
4
|
+
|
|
5
|
+
* Jazzy now only supports projects using Swift 1.2.
|
|
6
|
+
[JP Simard](https://github.com/jpsim)
|
|
7
|
+
[#170](https://github.com/realm/jazzy/issues/170)
|
|
8
|
+
|
|
9
|
+
* Increase default minimum ACL to public.
|
|
10
|
+
[JP Simard](https://github.com/jpsim)
|
|
11
|
+
[#186](https://github.com/realm/jazzy/issues/186)
|
|
12
|
+
|
|
13
|
+
##### Enhancements
|
|
14
|
+
|
|
15
|
+
* Use `key.accessibility` to determine ACL (value coming from SourceKit, which
|
|
16
|
+
is generally more accurate than parsing the declaration for an accessibility
|
|
17
|
+
keyword).
|
|
18
|
+
[JP Simard](https://github.com/jpsim)
|
|
19
|
+
[#185](https://github.com/realm/jazzy/issues/185)
|
|
20
|
+
|
|
21
|
+
##### Bug Fixes
|
|
22
|
+
|
|
23
|
+
* None.
|
|
24
|
+
|
|
25
|
+
|
|
1
26
|
## 0.1.6
|
|
2
27
|
|
|
3
28
|
##### Breaking
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
jazzy (0.
|
|
4
|
+
jazzy (0.2.0)
|
|
5
5
|
cocoapods (~> 0.36.0.rc.1)
|
|
6
6
|
mustache (~> 0.99)
|
|
7
7
|
open4
|
|
@@ -28,10 +28,10 @@ GEM
|
|
|
28
28
|
clintegracon (0.5.3)
|
|
29
29
|
colored (~> 1.2)
|
|
30
30
|
diffy
|
|
31
|
-
cocoapods (0.36.
|
|
31
|
+
cocoapods (0.36.4)
|
|
32
32
|
activesupport (>= 3.2.15)
|
|
33
33
|
claide (~> 0.8.1)
|
|
34
|
-
cocoapods-core (= 0.36.
|
|
34
|
+
cocoapods-core (= 0.36.4)
|
|
35
35
|
cocoapods-downloader (~> 0.9.0)
|
|
36
36
|
cocoapods-plugins (~> 0.4.1)
|
|
37
37
|
cocoapods-trunk (~> 0.6.0)
|
|
@@ -42,7 +42,7 @@ GEM
|
|
|
42
42
|
nap (~> 0.8)
|
|
43
43
|
open4 (~> 1.3)
|
|
44
44
|
xcodeproj (~> 0.23.1)
|
|
45
|
-
cocoapods-core (0.36.
|
|
45
|
+
cocoapods-core (0.36.4)
|
|
46
46
|
activesupport (>= 3.2.15)
|
|
47
47
|
fuzzy_match (~> 2.0.4)
|
|
48
48
|
nap (~> 0.8.0)
|
|
@@ -62,7 +62,7 @@ GEM
|
|
|
62
62
|
i18n (0.7.0)
|
|
63
63
|
json (1.8.2)
|
|
64
64
|
metaclass (0.0.4)
|
|
65
|
-
minitest (5.
|
|
65
|
+
minitest (5.6.0)
|
|
66
66
|
mocha (1.1.0)
|
|
67
67
|
metaclass (~> 0.0.1)
|
|
68
68
|
mocha-on-bacon (0.2.2)
|
|
@@ -80,7 +80,7 @@ GEM
|
|
|
80
80
|
bacon (~> 1.2)
|
|
81
81
|
rainbow (2.0.0)
|
|
82
82
|
rake (10.3.2)
|
|
83
|
-
redcarpet (3.2.
|
|
83
|
+
redcarpet (3.2.3)
|
|
84
84
|
rouge (1.8.0)
|
|
85
85
|
rubocop (0.26.1)
|
|
86
86
|
astrolabe (~> 1.3)
|
|
Binary file
|
|
Binary file
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<plist version="1.0">
|
|
4
4
|
<dict>
|
|
5
5
|
<key>BuildMachineOSBuild</key>
|
|
6
|
-
<string>
|
|
6
|
+
<string>14D136</string>
|
|
7
7
|
<key>CFBundleDevelopmentRegion</key>
|
|
8
8
|
<string>en</string>
|
|
9
9
|
<key>CFBundleExecutable</key>
|
|
@@ -25,17 +25,17 @@
|
|
|
25
25
|
<key>DTCompiler</key>
|
|
26
26
|
<string>com.apple.compilers.llvm.clang.1_0</string>
|
|
27
27
|
<key>DTPlatformBuild</key>
|
|
28
|
-
<string>
|
|
28
|
+
<string>6D1002</string>
|
|
29
29
|
<key>DTPlatformVersion</key>
|
|
30
30
|
<string>GM</string>
|
|
31
31
|
<key>DTSDKBuild</key>
|
|
32
|
-
<string>
|
|
32
|
+
<string>14D125</string>
|
|
33
33
|
<key>DTSDKName</key>
|
|
34
34
|
<string>macosx10.10</string>
|
|
35
35
|
<key>DTXcode</key>
|
|
36
|
-
<string>
|
|
36
|
+
<string>0631</string>
|
|
37
37
|
<key>DTXcodeBuild</key>
|
|
38
|
-
<string>
|
|
38
|
+
<string>6D1002</string>
|
|
39
39
|
<key>NSHumanReadableCopyright</key>
|
|
40
40
|
<string>Copyright © 2014 Carthage. All rights reserved.</string>
|
|
41
41
|
</dict>
|
|
Binary file
|
|
Binary file
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<plist version="1.0">
|
|
4
4
|
<dict>
|
|
5
5
|
<key>BuildMachineOSBuild</key>
|
|
6
|
-
<string>
|
|
6
|
+
<string>14D136</string>
|
|
7
7
|
<key>CFBundleDevelopmentRegion</key>
|
|
8
8
|
<string>en</string>
|
|
9
9
|
<key>CFBundleExecutable</key>
|
|
@@ -25,17 +25,17 @@
|
|
|
25
25
|
<key>DTCompiler</key>
|
|
26
26
|
<string>com.apple.compilers.llvm.clang.1_0</string>
|
|
27
27
|
<key>DTPlatformBuild</key>
|
|
28
|
-
<string>
|
|
28
|
+
<string>6D1002</string>
|
|
29
29
|
<key>DTPlatformVersion</key>
|
|
30
30
|
<string>GM</string>
|
|
31
31
|
<key>DTSDKBuild</key>
|
|
32
|
-
<string>
|
|
32
|
+
<string>14D125</string>
|
|
33
33
|
<key>DTSDKName</key>
|
|
34
34
|
<string>macosx10.10</string>
|
|
35
35
|
<key>DTXcode</key>
|
|
36
|
-
<string>
|
|
36
|
+
<string>0631</string>
|
|
37
37
|
<key>DTXcodeBuild</key>
|
|
38
|
-
<string>
|
|
38
|
+
<string>6D1002</string>
|
|
39
39
|
<key>NSHumanReadableCopyright</key>
|
|
40
40
|
<string>Copyright © 2014 Rob Napier. All rights reserved.</string>
|
|
41
41
|
<key>UIDeviceFamily</key>
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
3
|
+
<plist version="1.0">
|
|
4
|
+
<dict>
|
|
5
|
+
<key>BuildMachineOSBuild</key>
|
|
6
|
+
<string>14D136</string>
|
|
7
|
+
<key>CFBundleDevelopmentRegion</key>
|
|
8
|
+
<string>en</string>
|
|
9
|
+
<key>CFBundleExecutable</key>
|
|
10
|
+
<string>SWXMLHash</string>
|
|
11
|
+
<key>CFBundleIdentifier</key>
|
|
12
|
+
<string>drmohundro.SWXMLHash</string>
|
|
13
|
+
<key>CFBundleInfoDictionaryVersion</key>
|
|
14
|
+
<string>6.0</string>
|
|
15
|
+
<key>CFBundleName</key>
|
|
16
|
+
<string>SWXMLHash</string>
|
|
17
|
+
<key>CFBundlePackageType</key>
|
|
18
|
+
<string>FMWK</string>
|
|
19
|
+
<key>CFBundleShortVersionString</key>
|
|
20
|
+
<string>1.0</string>
|
|
21
|
+
<key>CFBundleSignature</key>
|
|
22
|
+
<string>????</string>
|
|
23
|
+
<key>CFBundleVersion</key>
|
|
24
|
+
<string>1</string>
|
|
25
|
+
<key>DTCompiler</key>
|
|
26
|
+
<string>com.apple.compilers.llvm.clang.1_0</string>
|
|
27
|
+
<key>DTPlatformBuild</key>
|
|
28
|
+
<string>6D1002</string>
|
|
29
|
+
<key>DTPlatformVersion</key>
|
|
30
|
+
<string>GM</string>
|
|
31
|
+
<key>DTSDKBuild</key>
|
|
32
|
+
<string>14D125</string>
|
|
33
|
+
<key>DTSDKName</key>
|
|
34
|
+
<string>macosx10.10</string>
|
|
35
|
+
<key>DTXcode</key>
|
|
36
|
+
<string>0631</string>
|
|
37
|
+
<key>DTXcodeBuild</key>
|
|
38
|
+
<string>6D1002</string>
|
|
39
|
+
<key>UIDeviceFamily</key>
|
|
40
|
+
<array>
|
|
41
|
+
<integer>1</integer>
|
|
42
|
+
<integer>2</integer>
|
|
43
|
+
</array>
|
|
44
|
+
</dict>
|
|
45
|
+
</plist>
|
|
Binary file
|
|
Binary file
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<plist version="1.0">
|
|
4
4
|
<dict>
|
|
5
5
|
<key>BuildMachineOSBuild</key>
|
|
6
|
-
<string>
|
|
6
|
+
<string>14D136</string>
|
|
7
7
|
<key>CFBundleDevelopmentRegion</key>
|
|
8
8
|
<string>en</string>
|
|
9
9
|
<key>CFBundleExecutable</key>
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
<key>CFBundlePackageType</key>
|
|
18
18
|
<string>FMWK</string>
|
|
19
19
|
<key>CFBundleShortVersionString</key>
|
|
20
|
-
<string>0.0
|
|
20
|
+
<string>1.0.0</string>
|
|
21
21
|
<key>CFBundleSignature</key>
|
|
22
22
|
<string>????</string>
|
|
23
23
|
<key>CFBundleVersion</key>
|
|
@@ -25,17 +25,17 @@
|
|
|
25
25
|
<key>DTCompiler</key>
|
|
26
26
|
<string>com.apple.compilers.llvm.clang.1_0</string>
|
|
27
27
|
<key>DTPlatformBuild</key>
|
|
28
|
-
<string>
|
|
28
|
+
<string>6D1002</string>
|
|
29
29
|
<key>DTPlatformVersion</key>
|
|
30
30
|
<string>GM</string>
|
|
31
31
|
<key>DTSDKBuild</key>
|
|
32
|
-
<string>
|
|
32
|
+
<string>14D125</string>
|
|
33
33
|
<key>DTSDKName</key>
|
|
34
34
|
<string>macosx10.10</string>
|
|
35
35
|
<key>DTXcode</key>
|
|
36
|
-
<string>
|
|
36
|
+
<string>0631</string>
|
|
37
37
|
<key>DTXcodeBuild</key>
|
|
38
|
-
<string>
|
|
38
|
+
<string>6D1002</string>
|
|
39
39
|
<key>NSHumanReadableCopyright</key>
|
|
40
40
|
<string>Copyright © 2014 JP Simard. All rights reserved.</string>
|
|
41
41
|
</dict>
|
|
Binary file
|
data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCore.dylib
CHANGED
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<plist version="1.0">
|
|
4
4
|
<dict>
|
|
5
5
|
<key>BuildMachineOSBuild</key>
|
|
6
|
-
<string>
|
|
6
|
+
<string>14D136</string>
|
|
7
7
|
<key>CFBundleDevelopmentRegion</key>
|
|
8
8
|
<string>en</string>
|
|
9
9
|
<key>CFBundleExecutable</key>
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
<key>CFBundlePackageType</key>
|
|
18
18
|
<string>FMWK</string>
|
|
19
19
|
<key>CFBundleShortVersionString</key>
|
|
20
|
-
<string>0.
|
|
20
|
+
<string>0.4.0</string>
|
|
21
21
|
<key>CFBundleSignature</key>
|
|
22
22
|
<string>????</string>
|
|
23
23
|
<key>CFBundleVersion</key>
|
|
@@ -25,17 +25,17 @@
|
|
|
25
25
|
<key>DTCompiler</key>
|
|
26
26
|
<string>com.apple.compilers.llvm.clang.1_0</string>
|
|
27
27
|
<key>DTPlatformBuild</key>
|
|
28
|
-
<string>
|
|
28
|
+
<string>6D1002</string>
|
|
29
29
|
<key>DTPlatformVersion</key>
|
|
30
30
|
<string>GM</string>
|
|
31
31
|
<key>DTSDKBuild</key>
|
|
32
|
-
<string>
|
|
32
|
+
<string>14D125</string>
|
|
33
33
|
<key>DTSDKName</key>
|
|
34
34
|
<string>macosx10.10</string>
|
|
35
35
|
<key>DTXcode</key>
|
|
36
|
-
<string>
|
|
36
|
+
<string>0631</string>
|
|
37
37
|
<key>DTXcodeBuild</key>
|
|
38
|
-
<string>
|
|
38
|
+
<string>6D1002</string>
|
|
39
39
|
<key>NSHumanReadableCopyright</key>
|
|
40
40
|
<string>Copyright © 2015 SourceKitten. All rights reserved.</string>
|
|
41
41
|
</dict>
|
data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/SourceKittenFramework
CHANGED
|
Binary file
|
|
Binary file
|
data/lib/jazzy/config.rb
CHANGED
|
@@ -39,7 +39,7 @@ module Jazzy
|
|
|
39
39
|
self.clean = false
|
|
40
40
|
self.docset_platform = 'jazzy'
|
|
41
41
|
self.version = '1.0'
|
|
42
|
-
self.min_acl = SourceDeclaration::AccessControlLevel.
|
|
42
|
+
self.min_acl = SourceDeclaration::AccessControlLevel.public
|
|
43
43
|
self.skip_undocumented = false
|
|
44
44
|
self.source_directory = Pathname.pwd
|
|
45
45
|
end
|
|
@@ -126,11 +126,11 @@ module Jazzy
|
|
|
126
126
|
|
|
127
127
|
opt.on('--min-acl [private | internal | public]',
|
|
128
128
|
'minimum access control level to document \
|
|
129
|
-
(default is
|
|
129
|
+
(default is public)') do |acl|
|
|
130
130
|
if acl == 'private'
|
|
131
131
|
config.min_acl = SourceDeclaration::AccessControlLevel.private
|
|
132
|
-
elsif acl == '
|
|
133
|
-
config.min_acl = SourceDeclaration::AccessControlLevel.
|
|
132
|
+
elsif acl == 'internal'
|
|
133
|
+
config.min_acl = SourceDeclaration::AccessControlLevel.internal
|
|
134
134
|
end
|
|
135
135
|
end
|
|
136
136
|
|
data/lib/jazzy/gem_version.rb
CHANGED
|
@@ -5,26 +5,54 @@ module Jazzy
|
|
|
5
5
|
|
|
6
6
|
attr_reader :level
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
8
|
+
ACCESSIBILITY_PRIVATE = 'source.lang.swift.accessibility.private'
|
|
9
|
+
ACCESSIBILITY_INTERNAL = 'source.lang.swift.accessibility.internal'
|
|
10
|
+
ACCESSIBILITY_PUBLIC = 'source.lang.swift.accessibility.public'
|
|
11
|
+
|
|
12
|
+
def initialize(accessibility)
|
|
13
|
+
if accessibility == ACCESSIBILITY_PRIVATE
|
|
10
14
|
@level = :private
|
|
11
|
-
elsif
|
|
15
|
+
elsif accessibility == ACCESSIBILITY_INTERNAL
|
|
16
|
+
@level = :internal
|
|
17
|
+
elsif accessibility == ACCESSIBILITY_PUBLIC
|
|
12
18
|
@level = :public
|
|
13
19
|
else
|
|
14
|
-
|
|
20
|
+
raise "cannot initialize AccessControlLevel with '#{accessibility}'"
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
def self.from_doc(doc)
|
|
25
|
+
accessibility = doc['key.accessibility']
|
|
26
|
+
if accessibility
|
|
27
|
+
acl = new(accessibility)
|
|
28
|
+
if acl
|
|
29
|
+
return acl
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
acl = from_explicit_declaration(doc['key.parsed_declaration'])
|
|
33
|
+
acl || AccessControlLevel.public # fallback on public ACL
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
def self.from_explicit_declaration(declaration_string)
|
|
37
|
+
if declaration_string =~ /private\ /
|
|
38
|
+
return AccessControlLevel.private
|
|
39
|
+
elsif declaration_string =~ /public\ /
|
|
40
|
+
return AccessControlLevel.public
|
|
41
|
+
elsif declaration_string =~ /internal\ /
|
|
42
|
+
return AccessControlLevel.internal
|
|
15
43
|
end
|
|
16
44
|
end
|
|
17
45
|
|
|
18
46
|
def self.private
|
|
19
|
-
|
|
47
|
+
new(ACCESSIBILITY_PRIVATE)
|
|
20
48
|
end
|
|
21
49
|
|
|
22
50
|
def self.internal
|
|
23
|
-
|
|
51
|
+
new(ACCESSIBILITY_INTERNAL)
|
|
24
52
|
end
|
|
25
53
|
|
|
26
54
|
def self.public
|
|
27
|
-
|
|
55
|
+
new(ACCESSIBILITY_PUBLIC)
|
|
28
56
|
end
|
|
29
57
|
|
|
30
58
|
LEVELS = {
|
data/lib/jazzy/sourcekitten.rb
CHANGED
|
@@ -12,6 +12,7 @@ module Jazzy
|
|
|
12
12
|
module SourceKitten
|
|
13
13
|
@documented_count = 0
|
|
14
14
|
@undocumented_tokens = []
|
|
15
|
+
@expected_swift_version = '1.2'
|
|
15
16
|
|
|
16
17
|
# Group root-level docs by type and add as children to a group doc element
|
|
17
18
|
def self.group_docs(docs, type)
|
|
@@ -56,7 +57,7 @@ module Jazzy
|
|
|
56
57
|
expected_xcode_select_path =
|
|
57
58
|
Pathname('/Applications/Xcode.app/Contents/Developer')
|
|
58
59
|
return if xcode_developer_directory == expected_xcode_select_path
|
|
59
|
-
raise 'Please install or symlink Xcode 6.
|
|
60
|
+
raise 'Please install or symlink Xcode 6.3 in ' \
|
|
60
61
|
"#{expected_xcode_select_path} and set as active developer " \
|
|
61
62
|
'directory by running `sudo xcode-select -s ' \
|
|
62
63
|
"#{expected_xcode_select_path}`"
|
|
@@ -70,9 +71,8 @@ module Jazzy
|
|
|
70
71
|
def self.assert_swift_version
|
|
71
72
|
swift_version = `xcrun swift --version` =~ /Swift version ([\d\.]+)/ &&
|
|
72
73
|
Regexp.last_match[1]
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
raise "Jazzy only works with Swift #{expected_swift_version}."
|
|
74
|
+
return if swift_version == @expected_swift_version
|
|
75
|
+
raise "Jazzy only works with Swift #{@expected_swift_version}."
|
|
76
76
|
end
|
|
77
77
|
|
|
78
78
|
# Run sourcekitten with given arguments and return STDOUT
|
|
@@ -104,8 +104,7 @@ module Jazzy
|
|
|
104
104
|
# Always document extensions, since we can't tell what ACL they are
|
|
105
105
|
return true if doc['key.kind'] == 'source.lang.swift.decl.extension'
|
|
106
106
|
|
|
107
|
-
SourceDeclaration::AccessControlLevel.
|
|
108
|
-
@min_acl
|
|
107
|
+
SourceDeclaration::AccessControlLevel.from_doc(doc) >= @min_acl
|
|
109
108
|
end
|
|
110
109
|
|
|
111
110
|
def self.process_undocumented_token(doc, declaration)
|
|
@@ -211,10 +210,8 @@ module Jazzy
|
|
|
211
210
|
declaration.usr = doc['key.usr']
|
|
212
211
|
declaration.name = doc['key.name']
|
|
213
212
|
declaration.mark = current_mark
|
|
214
|
-
|
|
215
|
-
doc
|
|
216
|
-
)
|
|
217
|
-
declaration.access_control_level = acl
|
|
213
|
+
declaration.access_control_level =
|
|
214
|
+
SourceDeclaration::AccessControlLevel.from_doc(doc)
|
|
218
215
|
declaration.start_line = doc['key.parsed_scope.start']
|
|
219
216
|
declaration.end_line = doc['key.parsed_scope.end']
|
|
220
217
|
|
data/spec/sourcekitten_spec.rb
CHANGED
|
@@ -15,17 +15,17 @@ module Jazzy
|
|
|
15
15
|
|
|
16
16
|
it 'validates the current xcode version' do
|
|
17
17
|
SourceKitten.stubs(:`).returns <<-O
|
|
18
|
-
Swift version 1.
|
|
19
|
-
Target: x86_64-apple-darwin14.
|
|
18
|
+
Apple Swift version 1.2 (swiftlang-602.0.49.6 clang-602.0.49)
|
|
19
|
+
Target: x86_64-apple-darwin14.3.0
|
|
20
20
|
O
|
|
21
21
|
should.not.raise { SourceKitten.assert_swift_version }
|
|
22
22
|
|
|
23
23
|
SourceKitten.stubs(:`).returns <<-O
|
|
24
|
-
|
|
24
|
+
Swift version 1.1 (swift-600.0.57.4)
|
|
25
25
|
Target: x86_64-apple-darwin14.1.0
|
|
26
26
|
O
|
|
27
27
|
should.raise { SourceKitten.assert_swift_version }.message.should
|
|
28
|
-
.match /Jazzy.*Swift 1\.
|
|
28
|
+
.match /Jazzy.*Swift 1\.2/
|
|
29
29
|
end
|
|
30
30
|
end
|
|
31
31
|
end
|
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.
|
|
4
|
+
version: 0.2.0
|
|
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: 2015-04-
|
|
13
|
+
date: 2015-04-23 00:00:00.000000000 Z
|
|
14
14
|
dependencies:
|
|
15
15
|
- !ruby/object:Gem::Dependency
|
|
16
16
|
name: cocoapods
|
|
@@ -163,22 +163,16 @@ files:
|
|
|
163
163
|
- lib/jazzy.rb
|
|
164
164
|
- lib/jazzy/SourceKitten/Commandant.framework/Commandant
|
|
165
165
|
- lib/jazzy/SourceKitten/Commandant.framework/Versions/A/Commandant
|
|
166
|
-
- lib/jazzy/SourceKitten/Commandant.framework/Versions/A/Modules/Commandant.swiftmodule/x86_64.swiftdoc
|
|
167
|
-
- lib/jazzy/SourceKitten/Commandant.framework/Versions/A/Modules/Commandant.swiftmodule/x86_64.swiftmodule
|
|
168
|
-
- lib/jazzy/SourceKitten/Commandant.framework/Versions/A/Modules/module.modulemap
|
|
169
166
|
- lib/jazzy/SourceKitten/Commandant.framework/Versions/A/Resources/Info.plist
|
|
170
167
|
- lib/jazzy/SourceKitten/LlamaKit.framework/LlamaKit
|
|
171
168
|
- lib/jazzy/SourceKitten/LlamaKit.framework/Versions/A/LlamaKit
|
|
172
|
-
- lib/jazzy/SourceKitten/LlamaKit.framework/Versions/A/Modules/LlamaKit.swiftmodule/x86_64.swiftdoc
|
|
173
|
-
- lib/jazzy/SourceKitten/LlamaKit.framework/Versions/A/Modules/LlamaKit.swiftmodule/x86_64.swiftmodule
|
|
174
|
-
- lib/jazzy/SourceKitten/LlamaKit.framework/Versions/A/Modules/module.modulemap
|
|
175
169
|
- lib/jazzy/SourceKitten/LlamaKit.framework/Versions/A/Resources/Info.plist
|
|
176
170
|
- lib/jazzy/SourceKitten/Rakefile
|
|
177
171
|
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/SourceKittenFramework
|
|
172
|
+
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash
|
|
173
|
+
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/Resources/Info.plist
|
|
174
|
+
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/SWXMLHash
|
|
178
175
|
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/SwiftXPC
|
|
179
|
-
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Modules/SwiftXPC.swiftmodule/x86_64.swiftdoc
|
|
180
|
-
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Modules/SwiftXPC.swiftmodule/x86_64.swiftmodule
|
|
181
|
-
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Modules/module.modulemap
|
|
182
176
|
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Resources/Info.plist
|
|
183
177
|
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/SwiftXPC
|
|
184
178
|
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCore.dylib
|
|
@@ -188,9 +182,6 @@ files:
|
|
|
188
182
|
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftFoundation.dylib
|
|
189
183
|
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftObjectiveC.dylib
|
|
190
184
|
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftSecurity.dylib
|
|
191
|
-
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Modules/SourceKittenFramework.swiftmodule/x86_64.swiftdoc
|
|
192
|
-
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Modules/SourceKittenFramework.swiftmodule/x86_64.swiftmodule
|
|
193
|
-
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Modules/module.modulemap
|
|
194
185
|
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Resources/Info.plist
|
|
195
186
|
- lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/SourceKittenFramework
|
|
196
187
|
- lib/jazzy/SourceKitten/sourcekitten
|
|
@@ -252,9 +243,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
252
243
|
version: '0'
|
|
253
244
|
requirements: []
|
|
254
245
|
rubyforge_project:
|
|
255
|
-
rubygems_version: 2.
|
|
246
|
+
rubygems_version: 2.2.2
|
|
256
247
|
signing_key:
|
|
257
248
|
specification_version: 4
|
|
258
249
|
summary: Soulful docs for Swift & Objective-C.
|
|
259
250
|
test_files: []
|
|
260
|
-
has_rdoc:
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|