jazzy 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ded8d78313e2fcab8ead87a65f4cf9f35d2584a1
-  data.tar.gz: eb426a586c8fce20e5e87c9ccbaac0466bd10d8d
+  metadata.gz: accd6c9ed649bd4be1a4bbc78ad1d0bce7c426de
+  data.tar.gz: 7b3d85bc26cef54041f0b9536e9273f283e952d6
 SHA512:
-  metadata.gz: 6694288ef466e3f3fa62508ae1905cbb1c76cf9a0a010b46ca167d08aa2d3dbc6951d306bcfb48102fe36758e8f89a45d429a992ac934b2dbe924198f3380891
-  data.tar.gz: 56ba55fa32962a163b739455a6f1965aead62019582e3cb8ca81e39f8d26df4723965ab5029fca2db0a3fecf62c11d3c948e93a987ae22d2826d3f67e32e8d02
+  metadata.gz: f738c74fb08575c110f13407de425ad988b582f56798fa09899a8e87735c62d966faf4e519eeae349a97393ee69b6c8ece48b1a2df3c2fc9623976dc4d1289d1
+  data.tar.gz: 77fd0c7d2d0ca3af3c284c04c1789747bff4e1dee6c7dfa567092bd3539ee3a1f9e67bf2438bda43f96aa572c4374ac21534006fb17b2df72f54984eaa171dfb

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 0.9.3
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* None.
+
+##### Bug Fixes
+
+* Fix crash when specifying empty Swift version. Now correctly uses the default
+  Swift version.  
+  [JP Simard](https://github.com/jpsim)
+
+* Fix jony theme selection.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#962](https://github.com/realm/jazzy/issues/962)
+
 ## 0.9.2
 
 ##### Breaking
@@ -738,7 +758,7 @@
   [#310](https://github.com/realm/jazzy/pull/310)
 
 * Render special list items (e.g. Throws, See, etc.). See
-  http://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/ for
+  https://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/ for
   a complete list.  
   [JP Simard](https://github.com/jpsim)
   [#317](https://github.com/realm/jazzy/issues/317)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.9.2)
+    jazzy (0.9.3)
       cocoapods (~> 1.0)
       mustache (~> 0.99)
       open4

data/README.md

@@ -54,7 +54,7 @@ all available options, run `jazzy --help config`.
 ### Supported keywords
 
 Swift documentation is written in markdown and supports a number of special keywords.
-For a complete list and examples, see Erica Sadun's post on [*Swift header documentation in Xcode 7*](http://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/),
+For a complete list and examples, see Erica Sadun's post on [*Swift header documentation in Xcode 7*](https://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/),
 her [book on Swift Documentation Markup](https://itunes.apple.com/us/book/swift-documentation-markup/id1049010423), and the [Xcode Markup Formatting Reference](https://developer.apple.com/library/content/documentation/Xcode/Reference/xcode_markup_formatting_ref/).
 
 For Objective-C documentation the same keywords are supported, but note that the format
@@ -186,7 +186,7 @@ Unlike the `--documentation` option, these files are not included in navigation
 
 This is very helpful when using `custom_categories` for grouping types and including relevant documentation in those sections.
 
-For an example of a project using both `--documentation` and `--abstract` see: [http://reswift.github.io/ReSwift/](http://reswift.github.io/ReSwift/)
+For an example of a project using both `--documentation` and `--abstract` see: [https://reswift.github.io/ReSwift/](https://reswift.github.io/ReSwift/)
 
 ### Controlling what is documented
 
@@ -273,10 +273,10 @@ See [our other open source projects](https://github.com/realm),
 read [our blog](https://realm.io/news) or say hi on twitter
 ([@realm](https://twitter.com/realm)).
 
-[clang]: http://clang.llvm.org "Clang"
-[sourcekit]: http://www.jpsim.com/uncovering-sourcekit "Uncovering SourceKit"
-[ast]: http://clang.llvm.org/docs/IntroductionToTheClangAST.html "Introduction To The Clang AST"
+[clang]: https://clang.llvm.org "Clang"
+[sourcekit]: https://www.jpsim.com/uncovering-sourcekit "Uncovering SourceKit"
+[ast]: https://clang.llvm.org/docs/IntroductionToTheClangAST.html "Introduction To The Clang AST"
 [xcode]: https://developer.apple.com/xcode "Xcode"
 [SourceKitten]: https://github.com/jpsim/SourceKitten "SourceKitten"
-[bundler]: http://rubygems.org/gems/bundler
-[mustache]: http://mustache.github.io "Mustache"
+[bundler]: https://rubygems.org/gems/bundler
+[mustache]: https://mustache.github.io "Mustache"

data/jazzy.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Soulful docs for Swift & Objective-C. ' \
                        "Run in your Xcode project's root directory for " \
                        'instant HTML docs.'
-  spec.homepage      = 'http://github.com/realm/jazzy'
+  spec.homepage      = 'https://github.com/realm/jazzy'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)

data/lib/jazzy/config.rb

@@ -180,9 +180,12 @@ module Jazzy
       command_line: '--swift-version VERSION',
       default: nil,
       parse: ->(v) do
-        return nil if v.to_s.empty?
-        raise 'jazzy only supports Swift 2.0 or later.' if v.to_f < 2
-        v
+        if v.to_s.empty?
+          nil
+        else
+          raise 'jazzy only supports Swift 2.0 or later.' if v.to_f < 2
+          v
+        end
       end
 
     # ──────── Metadata ────────
@@ -194,7 +197,7 @@ module Jazzy
 
     config_attr :author_url,
       command_line: ['-u', '--author_url URL'],
-      description: 'Author URL of this project (e.g. http://realm.io)',
+      description: 'Author URL of this project (e.g. https://realm.io)',
       default: '',
       parse: ->(u) { URI(u) }
 
@@ -252,7 +255,7 @@ module Jazzy
     config_attr :dash_url,
       command_line: ['-d', '--dash_url URL'],
       description: 'Location of the dash XML feed '\
-                    'e.g. http://realm.io/docsets/realm.xml)',
+                    'e.g. https://realm.io/docsets/realm.xml)',
       parse: ->(d) { URI(d) }
 
     config_attr :github_url,
@@ -302,7 +305,7 @@ module Jazzy
       description: ['Custom navigation categories to replace the standard '\
                     '“Classes, Protocols, etc.”', 'Types not explicitly named '\
                     'in a custom category appear in generic groups at the end.',
-                    'Example: http://git.io/v4Bcp'],
+                    'Example: https://git.io/v4Bcp'],
       default: []
 
     config_attr :custom_head,
@@ -310,15 +313,19 @@ module Jazzy
       description: 'Custom HTML to inject into <head></head>.',
       default: ''
 
+    BUILTIN_THEME_DIR = Pathname(__FILE__).parent + 'themes'
+    BUILTIN_THEMES = BUILTIN_THEME_DIR.children(false).map(&:to_s)
+
     config_attr :theme_directory,
-      command_line: '--theme [apple | fullwidth | jony | DIRPATH]',
+      command_line: "--theme [#{BUILTIN_THEMES.join(' | ')} | DIRPATH]",
       description: "Which theme to use. Specify either 'apple' (default), "\
-                   "'fullwidth', 'jony' or the path to your mustache " \
-                   'templates and other assets for a custom theme.',
+                   'one of the other built-in theme names, or the path to '\
+                   'your mustache templates and other assets for a custom '\
+                   'theme.',
       default: 'apple',
       parse: ->(t) do
-        if %w[apple fullwidth].include?(t)
-          Pathname(__FILE__).parent + 'themes' + t
+        if BUILTIN_THEMES.include?(t)
+          BUILTIN_THEME_DIR + t
         else
           expand_path(t)
         end

data/lib/jazzy/docset_builder.rb

@@ -3,7 +3,7 @@ require 'sqlite3'
 
 module Jazzy
   module DocBuilder
-    # Follows the instructions found at http://kapeli.com/docsets#dashDocset.
+    # Follows the instructions found at https://kapeli.com/docsets#dashDocset.
     class DocsetBuilder
       include Config::Mixin
 

data/lib/jazzy/gem_version.rb

@@ -1,3 +1,3 @@
 module Jazzy
-  VERSION = '0.9.2'.freeze unless defined? Jazzy::VERSION
+  VERSION = '0.9.3'.freeze unless defined? Jazzy::VERSION
 end

data/lib/jazzy/themes/apple/templates/footer.mustache

@@ -1,4 +1,4 @@
 <section id="footer">
   {{{copyright}}}
-  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
 </section>

data/lib/jazzy/themes/fullwidth/templates/footer.mustache

@@ -1,4 +1,4 @@
 <section class="footer">
   {{{copyright}}}
-  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
 </section>

data/lib/jazzy/themes/jony/templates/footer.mustache

@@ -1,4 +1,4 @@
 <section id="footer">
   {{{copyright}}}
-  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+  <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
 </section>

data/spec/integration_spec.rb

@@ -210,8 +210,9 @@ describe_cli 'jazzy' do
       behaves_like cli_spec 'document_siesta',
                             # Siesta already has Docs/
                             '--output api-docs',
-                            # Use Swift 4.1 rather than the specified 3.0.2
-                            '--swift-version=4.1'
+                            # Use the default Swift version rather than the
+                            # specified 4.0
+                            '--swift-version='
     end
 
     describe 'Creates docs for Swift project with a variety of contents' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-21 00:00:00.000000000 Z
+date: 2018-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -258,7 +258,7 @@ files:
 - spec/sourcekitten_spec.rb
 - spec/spec_helper.rb
 - spec/spec_helper/pre_flight.rb
-homepage: http://github.com/realm/jazzy
+homepage: https://github.com/realm/jazzy
 licenses:
 - MIT
 metadata: {}