jazzy 0.13.2 → 0.13.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (113) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/Tests.yml +52 -0
  3. data/.gitignore +1 -0
  4. data/CHANGELOG.md +118 -0
  5. data/CONTRIBUTING.md +5 -5
  6. data/Gemfile.lock +68 -59
  7. data/README.md +65 -5
  8. data/Rakefile +30 -0
  9. data/bin/sourcekitten +0 -0
  10. data/js/package-lock.json +44 -0
  11. data/js/package.json +17 -0
  12. data/lib/jazzy/config.rb +29 -8
  13. data/lib/jazzy/doc_builder.rb +14 -2
  14. data/lib/jazzy/docset_builder.rb +2 -0
  15. data/lib/jazzy/docset_builder/info_plist.mustache +8 -0
  16. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.ttf +0 -0
  17. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff +0 -0
  18. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff2 +0 -0
  19. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.ttf +0 -0
  20. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.woff +0 -0
  21. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.woff2 +0 -0
  22. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.ttf +0 -0
  23. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.woff +0 -0
  24. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.woff2 +0 -0
  25. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.ttf +0 -0
  26. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.woff +0 -0
  27. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.woff2 +0 -0
  28. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.ttf +0 -0
  29. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.woff +0 -0
  30. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.woff2 +0 -0
  31. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.ttf +0 -0
  32. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.woff +0 -0
  33. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.woff2 +0 -0
  34. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.ttf +0 -0
  35. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.woff +0 -0
  36. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.woff2 +0 -0
  37. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.ttf +0 -0
  38. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.woff +0 -0
  39. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.woff2 +0 -0
  40. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.ttf +0 -0
  41. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.woff +0 -0
  42. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.woff2 +0 -0
  43. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.ttf +0 -0
  44. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.woff +0 -0
  45. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.woff2 +0 -0
  46. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.ttf +0 -0
  47. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.woff +0 -0
  48. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.woff2 +0 -0
  49. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.ttf +0 -0
  50. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.woff +0 -0
  51. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.woff2 +0 -0
  52. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.ttf +0 -0
  53. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.woff +0 -0
  54. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.woff2 +0 -0
  55. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.ttf +0 -0
  56. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.woff +0 -0
  57. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.woff2 +0 -0
  58. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.ttf +0 -0
  59. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.woff +0 -0
  60. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.woff2 +0 -0
  61. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.ttf +0 -0
  62. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.woff +0 -0
  63. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.woff2 +0 -0
  64. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.ttf +0 -0
  65. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.woff +0 -0
  66. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.woff2 +0 -0
  67. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.ttf +0 -0
  68. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.woff +0 -0
  69. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.woff2 +0 -0
  70. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.ttf +0 -0
  71. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.woff +0 -0
  72. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.woff2 +0 -0
  73. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.ttf +0 -0
  74. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.woff +0 -0
  75. data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.woff2 +0 -0
  76. data/lib/jazzy/extensions/katex/css/katex.min.css +1 -1
  77. data/lib/jazzy/extensions/katex/js/katex.min.js +1 -1
  78. data/lib/jazzy/gem_version.rb +1 -1
  79. data/lib/jazzy/jazzy_markdown.rb +38 -0
  80. data/lib/jazzy/podspec_documenter.rb +15 -3
  81. data/lib/jazzy/source_declaration.rb +15 -2
  82. data/lib/jazzy/source_declaration/type.rb +30 -0
  83. data/lib/jazzy/source_module.rb +2 -1
  84. data/lib/jazzy/sourcekitten.rb +11 -11
  85. data/lib/jazzy/symbol_graph.rb +95 -0
  86. data/lib/jazzy/symbol_graph/constraint.rb +94 -0
  87. data/lib/jazzy/symbol_graph/ext_node.rb +114 -0
  88. data/lib/jazzy/symbol_graph/graph.rb +193 -0
  89. data/lib/jazzy/symbol_graph/relationship.rb +39 -0
  90. data/lib/jazzy/symbol_graph/sym_node.rb +158 -0
  91. data/lib/jazzy/symbol_graph/symbol.rb +219 -0
  92. data/lib/jazzy/themes/apple/assets/css/jazzy.css.scss +96 -3
  93. data/lib/jazzy/themes/apple/assets/img/spinner.gif +0 -0
  94. data/lib/jazzy/themes/apple/assets/js/jazzy.search.js +70 -0
  95. data/lib/jazzy/themes/apple/assets/js/jquery.min.js +2 -2
  96. data/lib/jazzy/themes/apple/assets/js/lunr.min.js +6 -0
  97. data/lib/jazzy/themes/apple/assets/js/typeahead.jquery.js +1694 -0
  98. data/lib/jazzy/themes/apple/templates/doc.mustache +35 -0
  99. data/lib/jazzy/themes/apple/templates/header.mustache +7 -0
  100. data/lib/jazzy/themes/apple/templates/task.mustache +1 -1
  101. data/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss +5 -0
  102. data/lib/jazzy/themes/fullwidth/assets/js/jquery.min.js +2 -2
  103. data/lib/jazzy/themes/fullwidth/assets/js/lunr.min.js +6 -1
  104. data/lib/jazzy/themes/fullwidth/assets/js/typeahead.jquery.js +34 -14
  105. data/lib/jazzy/themes/fullwidth/templates/doc.mustache +30 -0
  106. data/lib/jazzy/themes/fullwidth/templates/task.mustache +1 -1
  107. data/lib/jazzy/themes/jony/assets/css/jazzy.css.scss +29 -1
  108. data/lib/jazzy/themes/jony/assets/js/jquery.min.js +2 -2
  109. data/lib/jazzy/themes/jony/templates/doc.mustache +30 -0
  110. data/lib/jazzy/themes/jony/templates/task.mustache +1 -1
  111. data/spec/integration_spec.rb +17 -8
  112. metadata +20 -8
  113. data/.circleci/config.yml +0 -83
metadata CHANGED
@@ -1,17 +1,17 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jazzy
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.13.2
4
+ version: 0.13.7
5
5
  platform: ruby
6
6
  authors:
7
7
  - JP Simard
8
8
  - Tim Anglade
9
9
  - Samuel Giddins
10
10
  - John Fairhurst
11
- autorequire:
11
+ autorequire:
12
12
  bindir: bin
13
13
  cert_chain: []
14
- date: 2020-04-02 00:00:00.000000000 Z
14
+ date: 2021-05-06 00:00:00.000000000 Z
15
15
  dependencies:
16
16
  - !ruby/object:Gem::Dependency
17
17
  name: cocoapods
@@ -168,7 +168,7 @@ executables:
168
168
  extensions: []
169
169
  extra_rdoc_files: []
170
170
  files:
171
- - ".circleci/config.yml"
171
+ - ".github/workflows/Tests.yml"
172
172
  - ".gitignore"
173
173
  - ".gitmodules"
174
174
  - ".rubocop.yml"
@@ -188,6 +188,8 @@ files:
188
188
  - images/realm.png
189
189
  - images/screenshot.jpg
190
190
  - jazzy.gemspec
191
+ - js/package-lock.json
192
+ - js/package.json
191
193
  - lib/jazzy.rb
192
194
  - lib/jazzy/config.rb
193
195
  - lib/jazzy/doc.rb
@@ -271,13 +273,24 @@ files:
271
273
  - lib/jazzy/source_module.rb
272
274
  - lib/jazzy/sourcekitten.rb
273
275
  - lib/jazzy/stats.rb
276
+ - lib/jazzy/symbol_graph.rb
277
+ - lib/jazzy/symbol_graph/constraint.rb
278
+ - lib/jazzy/symbol_graph/ext_node.rb
279
+ - lib/jazzy/symbol_graph/graph.rb
280
+ - lib/jazzy/symbol_graph/relationship.rb
281
+ - lib/jazzy/symbol_graph/sym_node.rb
282
+ - lib/jazzy/symbol_graph/symbol.rb
274
283
  - lib/jazzy/themes/apple/assets/css/highlight.css.scss
275
284
  - lib/jazzy/themes/apple/assets/css/jazzy.css.scss
276
285
  - lib/jazzy/themes/apple/assets/img/carat.png
277
286
  - lib/jazzy/themes/apple/assets/img/dash.png
278
287
  - lib/jazzy/themes/apple/assets/img/gh.png
288
+ - lib/jazzy/themes/apple/assets/img/spinner.gif
279
289
  - lib/jazzy/themes/apple/assets/js/jazzy.js
290
+ - lib/jazzy/themes/apple/assets/js/jazzy.search.js
280
291
  - lib/jazzy/themes/apple/assets/js/jquery.min.js
292
+ - lib/jazzy/themes/apple/assets/js/lunr.min.js
293
+ - lib/jazzy/themes/apple/assets/js/typeahead.jquery.js
281
294
  - lib/jazzy/themes/apple/templates/deprecation.mustache
282
295
  - lib/jazzy/themes/apple/templates/doc.mustache
283
296
  - lib/jazzy/themes/apple/templates/footer.mustache
@@ -328,7 +341,7 @@ homepage: https://github.com/realm/jazzy
328
341
  licenses:
329
342
  - MIT
330
343
  metadata: {}
331
- post_install_message:
344
+ post_install_message:
332
345
  rdoc_options: []
333
346
  require_paths:
334
347
  - lib
@@ -343,9 +356,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
343
356
  - !ruby/object:Gem::Version
344
357
  version: '0'
345
358
  requirements: []
346
- rubyforge_project:
347
- rubygems_version: 2.7.3
348
- signing_key:
359
+ rubygems_version: 3.1.4
360
+ signing_key:
349
361
  specification_version: 4
350
362
  summary: Soulful docs for Swift & Objective-C.
351
363
  test_files: []
data/.circleci/config.yml DELETED
@@ -1,83 +0,0 @@
1
- aliases:
2
- - &save-mac-bundler-cache
3
- key: bundle_mac
4
- paths:
5
- - vendor/bundle
6
-
7
- - &restore-mac-bundler-cache
8
- key: bundle_mac
9
-
10
- - &bundler-environment
11
- BUNDLE_JOBS: 3
12
- BUNDLE_RETRY: 3
13
- BUNDLE_PATH: vendor/bundle
14
-
15
- version: 2
16
- jobs:
17
-
18
- swift:
19
- macos:
20
- xcode: "11.4.0"
21
- environment: *bundler-environment
22
- steps:
23
- - checkout
24
- - restore_cache: *restore-mac-bundler-cache
25
- - run: bundle install
26
- - run: git submodule update --init --recursive
27
- - run: bundle exec rake swift_spec
28
- - save_cache: *save-mac-bundler-cache
29
-
30
- objc:
31
- macos:
32
- xcode: "11.4.0"
33
- environment: *bundler-environment
34
- steps:
35
- - checkout
36
- - restore_cache: *restore-mac-bundler-cache
37
- - run: bundle install
38
- - run: git submodule update --init --recursive
39
- - run: bundle exec rake objc_spec
40
- - save_cache: *save-mac-bundler-cache
41
-
42
- cocoapods:
43
- macos:
44
- xcode: "11.4.0"
45
- environment: *bundler-environment
46
- steps:
47
- - checkout
48
- - restore_cache:
49
- key: cocoapods
50
- - restore_cache: *restore-mac-bundler-cache
51
- - run: bundle install
52
- - run: git submodule update --init --recursive
53
- - run: bundle exec rake cocoapods_spec
54
- - save_cache:
55
- key: cocoapods
56
- paths:
57
- - ~/.cocoapods
58
- - save_cache: *save-mac-bundler-cache
59
-
60
- danger_and_rubocop:
61
- docker:
62
- - image: circleci/ruby:2.4-node
63
- environment: *bundler-environment
64
- steps:
65
- - checkout
66
- - restore_cache:
67
- key: bundle_linux
68
- - run: bundle install
69
- - run: bundle exec danger --verbose || true
70
- - run: bundle exec rake rubocop
71
- - save_cache:
72
- key: bundle_linux
73
- paths:
74
- - vendor/bundle
75
-
76
- workflows:
77
- version: 2
78
- workflow:
79
- jobs:
80
- - swift
81
- - objc
82
- - cocoapods
83
- - danger_and_rubocop