jazzy 0.7.3 → 0.7.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +6 -0
  3. data/CHANGELOG.md +72 -0
  4. data/CONTRIBUTING.md +3 -1
  5. data/Gemfile.lock +31 -29
  6. data/README.md +11 -10
  7. data/circle.yml +12 -0
  8. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Resources +1 -0
  9. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/SourceKittenFramework +1 -0
  10. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Commandant +1 -0
  11. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Resources +1 -0
  12. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/Current +1 -0
  13. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Resources +1 -0
  14. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Result +1 -0
  15. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/Current +1 -0
  16. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Resources +1 -0
  17. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash +1 -0
  18. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/Current +1 -0
  19. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Resources +1 -0
  20. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/Current +1 -0
  21. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Yams +1 -0
  22. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current +1 -0
  23. data/lib/jazzy/config.rb +16 -2
  24. data/lib/jazzy/doc_builder.rb +60 -8
  25. data/lib/jazzy/gem_version.rb +1 -1
  26. data/lib/jazzy/jazzy_markdown.rb +37 -25
  27. data/lib/jazzy/podspec_documenter.rb +3 -4
  28. data/lib/jazzy/search_builder.rb +21 -0
  29. data/lib/jazzy/source_declaration.rb +1 -1
  30. data/lib/jazzy/source_declaration/type.rb +7 -0
  31. data/lib/jazzy/source_document.rb +9 -0
  32. data/lib/jazzy/sourcekitten.rb +112 -60
  33. data/lib/jazzy/themes/apple/assets/js/jazzy.js +6 -0
  34. data/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss +62 -0
  35. data/lib/jazzy/themes/fullwidth/assets/img/spinner.gif +0 -0
  36. data/lib/jazzy/themes/fullwidth/assets/js/jazzy.js +6 -0
  37. data/lib/jazzy/themes/fullwidth/assets/js/jazzy.search.js +62 -0
  38. data/lib/jazzy/themes/fullwidth/assets/js/lunr.min.js +6 -0
  39. data/lib/jazzy/themes/fullwidth/assets/js/typeahead.jquery.js +1538 -0
  40. data/lib/jazzy/themes/fullwidth/templates/doc.mustache +5 -0
  41. data/lib/jazzy/themes/fullwidth/templates/header.mustache +8 -0
  42. data/spec/integration_spec.rb +11 -9
  43. metadata +19 -4
  44. data/.travis.yml +0 -17
  45. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/SourceKittenFramework +0 -0
  46. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Commandant +0 -0
  47. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Result +0 -0
  48. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash +0 -0
  49. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Yams +0 -0
@@ -8,6 +8,11 @@
8
8
  <script src="{{path_to_root}}js/jquery.min.js" defer></script>
9
9
  <script src="{{path_to_root}}js/jazzy.js" defer></script>
10
10
  {{{custom_head}}}
11
+ {{^disable_search}}
12
+ <script src="{{path_to_root}}js/lunr.min.js" defer></script>
13
+ <script src="{{path_to_root}}js/typeahead.jquery.js" defer></script>
14
+ <script src="{{path_to_root}}js/jazzy.search.js" defer></script>
15
+ {{/disable_search}}
11
16
  </head>
12
17
  <body>
13
18
 
@@ -6,6 +6,14 @@
6
6
  {{#doc_coverage}} ({{doc_coverage}}% documented){{/doc_coverage}}
7
7
  </p>
8
8
 
9
+ {{^disable_search}}
10
+ <p class="header-col--secondary">
11
+ <form role="search" action="{{path_to_root}}search.json">
12
+ <input type="text" placeholder="Search documentation" data-typeahead>
13
+ </form>
14
+ </p>
15
+ {{/disable_search}}
16
+
9
17
  {{#github_url}}
10
18
  <p class="header-col header-col--secondary">
11
19
  <a class="header-link" href="{{github_url}}">
@@ -75,7 +75,9 @@ CLIntegracon.configure do |c|
75
75
  path,
76
76
  File.read(path).gsub(
77
77
  (ROOT + 'tmp').to_s,
78
- '<TMP>'))
78
+ '<TMP>',
79
+ ),
80
+ )
79
81
  end
80
82
 
81
83
  # Transform produced databases to csv
@@ -104,8 +106,6 @@ describe_cli 'jazzy' do
104
106
  s.replace_pattern /^[\d\s:.-]+ ruby\[\d+:\d+\] warning:.*$[\n]?/, ''
105
107
  end
106
108
 
107
- travis_swift = ENV['TRAVIS_SWIFT_VERSION']
108
-
109
109
  require 'shellwords'
110
110
  realm_head = <<-HTML
111
111
  <link rel="icon" href="https://realm.io/img/favicon.ico">
@@ -159,9 +159,10 @@ describe_cli 'jazzy' do
159
159
  end
160
160
  end
161
161
 
162
- describe 'jazzy swift 2.2' do
162
+ describe 'jazzy swift' do
163
163
  describe 'Creates docs for a podspec with dependencies and subspecs' do
164
- behaves_like cli_spec 'document_moya_podspec', '--podspec=Moya.podspec'
164
+ behaves_like cli_spec 'document_moya_podspec',
165
+ '--podspec=Moya.podspec'
165
166
  end
166
167
 
167
168
  describe 'Creates docs with a module name, author name, project URL, ' \
@@ -172,9 +173,10 @@ describe_cli 'jazzy' do
172
173
  '-x -project,Alamofire.xcodeproj,-dry-run ' \
173
174
  '-g https://github.com/Alamofire/Alamofire ' \
174
175
  '--github-file-prefix https://github.com/' \
175
- 'Alamofire/Alamofire/blob/3.4.0 ' \
176
- '--module-version 3.4.0 ' \
177
- '-r http://static.realm.io/jazzy_demo/Alamofire/ ' \
176
+ 'Alamofire/Alamofire/blob/4.3.0 ' \
177
+ '--module-version 4.3.0 ' \
178
+ '--root-url ' \
179
+ 'https://static.realm.io/jazzy_demo/Alamofire/ ' \
178
180
  '--skip-undocumented'
179
181
  end
180
182
 
@@ -207,5 +209,5 @@ describe_cli 'jazzy' do
207
209
  describe 'Creates docs for Swift project with a variety of contents' do
208
210
  behaves_like cli_spec 'misc_jazzy_features'
209
211
  end
210
- end if !travis_swift || travis_swift == '2.2'
212
+ end
211
213
  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.7.3
4
+ version: 0.7.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: 2016-12-01 00:00:00.000000000 Z
13
+ date: 2017-02-08 00:00:00.000000000 Z
14
14
  dependencies:
15
15
  - !ruby/object:Gem::Dependency
16
16
  name: cocoapods
@@ -165,7 +165,6 @@ files:
165
165
  - ".gitignore"
166
166
  - ".gitmodules"
167
167
  - ".rubocop.yml"
168
- - ".travis.yml"
169
168
  - CHANGELOG.md
170
169
  - CONTRIBUTING.md
171
170
  - Dangerfile
@@ -175,24 +174,34 @@ files:
175
174
  - README.md
176
175
  - Rakefile
177
176
  - bin/jazzy
177
+ - circle.yml
178
178
  - images/logo.jpg
179
179
  - images/logo.sketch
180
180
  - images/realm.png
181
181
  - images/screenshot.jpg
182
182
  - jazzy.gemspec
183
183
  - lib/jazzy.rb
184
+ - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Resources
184
185
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/SourceKittenFramework
185
186
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Commandant
187
+ - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Resources
186
188
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Commandant
187
189
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Resources/Info.plist
190
+ - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/Current
191
+ - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Resources
188
192
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Result
189
193
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Resources/Info.plist
190
194
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Result
195
+ - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/Current
196
+ - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Resources
191
197
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash
192
198
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/Resources/Info.plist
193
199
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/SWXMLHash
200
+ - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/Current
201
+ - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Resources
194
202
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/A/Resources/Info.plist
195
203
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/A/Yams
204
+ - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/Current
196
205
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Yams
197
206
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCore.dylib
198
207
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCoreGraphics.dylib
@@ -203,6 +212,7 @@ files:
203
212
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftObjectiveC.dylib
204
213
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Resources/Info.plist
205
214
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/SourceKittenFramework
215
+ - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current
206
216
  - lib/jazzy/SourceKitten/Rakefile
207
217
  - lib/jazzy/SourceKitten/bin/sourcekitten
208
218
  - lib/jazzy/config.rb
@@ -217,6 +227,7 @@ files:
217
227
  - lib/jazzy/jazzy_markdown.rb
218
228
  - lib/jazzy/podspec_documenter.rb
219
229
  - lib/jazzy/readme_generator.rb
230
+ - lib/jazzy/search_builder.rb
220
231
  - lib/jazzy/source_declaration.rb
221
232
  - lib/jazzy/source_declaration/access_control_level.rb
222
233
  - lib/jazzy/source_declaration/type.rb
@@ -243,8 +254,12 @@ files:
243
254
  - lib/jazzy/themes/fullwidth/assets/img/carat.png
244
255
  - lib/jazzy/themes/fullwidth/assets/img/dash.png
245
256
  - lib/jazzy/themes/fullwidth/assets/img/gh.png
257
+ - lib/jazzy/themes/fullwidth/assets/img/spinner.gif
246
258
  - lib/jazzy/themes/fullwidth/assets/js/jazzy.js
259
+ - lib/jazzy/themes/fullwidth/assets/js/jazzy.search.js
247
260
  - lib/jazzy/themes/fullwidth/assets/js/jquery.min.js
261
+ - lib/jazzy/themes/fullwidth/assets/js/lunr.min.js
262
+ - lib/jazzy/themes/fullwidth/assets/js/typeahead.jquery.js
248
263
  - lib/jazzy/themes/fullwidth/templates/doc.mustache
249
264
  - lib/jazzy/themes/fullwidth/templates/footer.mustache
250
265
  - lib/jazzy/themes/fullwidth/templates/header.mustache
@@ -276,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
276
291
  version: '0'
277
292
  requirements: []
278
293
  rubyforge_project:
279
- rubygems_version: 2.4.5.1
294
+ rubygems_version: 2.6.8
280
295
  signing_key:
281
296
  specification_version: 4
282
297
  summary: Soulful docs for Swift & Objective-C.
data/.travis.yml DELETED
@@ -1,17 +0,0 @@
1
- language: objective-c
2
- branches:
3
- only:
4
- - master
5
- git:
6
- submodules: false
7
- before_install: git submodule update --init --recursive
8
- script:
9
- - bundle exec rake spec
10
- - bundle exec danger || true
11
- notifications:
12
- email: false
13
- slack: realmio:vPdpsG9NLDo2DNlbqtcMAQuE
14
- matrix:
15
- include:
16
- - osx_image: xcode7.3
17
- env: TRAVIS_SWIFT_VERSION=2.2