jazzy 0.13.2 → 0.13.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2b86b6a980392f1c5e55ebdc6a3d5be34f470c88ed12733ef10d1b10ee09078
-  data.tar.gz: 1e6e4a7d19a8eaee854a859b0ec603d239ea3ed8fb4fbd278e3c6b58673c105e
+  metadata.gz: e4d4a1f9abe64eefec69e00a77a3bfd37508a7ac385e0f133c640e2c5ce27fe8
+  data.tar.gz: 536e7ac40c9925df3bcc72f485c13966a826ffe7ca96e1e62fea2b0f918f849f
 SHA512:
-  metadata.gz: 0f9d68395fc4485cfbda0eb968170eeb5b624f7b5c1132e50f636cb9b74e9b6435caf69f5d66d2f1bd68220b8e0cba3dd5d526bea8d672849421ffde75627cb5
-  data.tar.gz: a288fbb15a612580d0f6f1e95325f5899cc90d76bf04c05a4e4153c6df82044c281113a14a60179d2105ba92cfeea80fecd5b27fcbeba19eb053f91db3cefbc2
+  metadata.gz: 5f573f8e91c36b5bc066fc83571835646700fc738a96a3f1345e3120f6a0fb228358787798e599689c998f011fc05c075af4e890530033907ef9c0f92194163a
+  data.tar.gz: b315b7503a0e6bec31ddeb009b00858e835a0f7a3d08b5b050966ceda498dce82a1e540e10d6de7c393b02abf6cd05c0476525a7c81a44e004a82c3993be842f

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+## 0.13.3
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Added a config option to provide sources of privately hosted pod
+  dependencies when using the `--podspec` option.
+  `--pod-sources url1,url2,…urlN`.  
+  [Jonathan Bailey](https://github.com/jon889)
+  [#650](https://github.com/realm/jazzy/issues/650)
+
+* Improve Dash docset support: support online redirection when
+  `--root-url` is set, and provide `--docset-playground-url` to
+  support docset playground links.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Bug Fixes
+
+* Fix module version not being used from podspec.  
+  [Jonathan Bailey](https://github.com/jon889)
+
+* Autolink Swift custom attributes/property wrappers.  
+  [John Fairhurst](https://github.com/johnfairh)
+
 ## 0.13.2
 
 ##### Breaking

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.13.2)
+    jazzy (0.13.3)
       cocoapods (~> 1.5)
       mustache (~> 1.1)
       open4
@@ -72,7 +72,7 @@ GEM
     cocoapods-trunk (1.4.1)
       nap (>= 0.8, < 2.0)
       netrc (~> 0.11)
-    cocoapods-try (1.1.0)
+    cocoapods-try (1.2.0)
     colored (1.2)
     colored2 (3.1.2)
     concurrent-ruby (1.1.6)
@@ -80,12 +80,12 @@ GEM
       colored2 (~> 3.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    danger (6.3.2)
+    danger (7.0.0)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
-      faraday (~> 0.9)
+      faraday (>= 0.9.0, < 2.0)
       faraday-http-cache (~> 2.0)
       git (~> 1.6)
       kramdown (~> 2.0)
@@ -97,10 +97,10 @@ GEM
     escape (0.0.4)
     ethon (0.12.0)
       ffi (>= 1.3.0)
-    faraday (0.17.3)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (2.0.0)
-      faraday (~> 0.8)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
     ffi (1.12.2)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
@@ -112,7 +112,8 @@ GEM
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     json (2.3.0)
-    kramdown (2.1.0)
+    kramdown (2.2.1)
+      rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liferaft (0.0.6)
@@ -132,18 +133,19 @@ GEM
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
     parallel (1.19.1)
-    parser (2.7.0.5)
+    parser (2.7.1.1)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    public_suffix (4.0.3)
+    public_suffix (4.0.4)
     rainbow (2.2.2)
       rake
     rake (13.0.1)
     rchardet (1.8.0)
     redcarpet (3.5.0)
-    rouge (3.17.0)
+    rexml (3.2.4)
+    rouge (3.18.0)
     rubocop (0.49.0)
       parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
@@ -154,7 +156,7 @@ GEM
     ruby-macho (1.4.0)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    sassc (2.2.1)
+    sassc (2.3.0)
       ffi (~> 1.9)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
@@ -165,7 +167,7 @@ GEM
     thread_safe (0.3.6)
     typhoeus (1.3.1)
       ethon (>= 0.9.0)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
     webmock (3.8.3)
@@ -174,7 +176,7 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.15.0)
+    xcodeproj (1.16.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)

data/lib/jazzy/config.rb

@@ -59,7 +59,7 @@ module Jazzy
 
       def full_command_line_name
         long_option_names = command_line.map do |opt|
-          Regexp.last_match(1) if opt =~ %r{
+          Regexp.last_match(1) if opt.to_s =~ %r{
             ^--           # starts with double dash
             (?:\[no-\])?  # optional prefix for booleans
             ([^\s]+)      # long option name
@@ -289,6 +289,14 @@ module Jazzy
       parse: ->(ps) { PodspecDocumenter.create_podspec(Pathname(ps)) if ps },
       default: Dir['*.podspec{,.json}'].first
 
+    config_attr :pod_sources,
+      command_line: ['--pod-sources url1,url2,…urlN', Array],
+      description: 'A list of sources to find pod dependencies. Used only '\
+                   'with --podspec when the podspec contains references to '\
+                   'privately hosted pods. You must include the default pod '\
+                   'source if public pods are also used.',
+      default: []
+
     config_attr :docset_icon,
       command_line: '--docset-icon FILEPATH',
       parse: ->(di) { expand_path(di) }
@@ -321,6 +329,11 @@ module Jazzy
       description: 'GitHub URL file prefix of this project (e.g. '\
                    'https://github.com/realm/realm-cocoa/tree/v0.87.1)'
 
+    config_attr :docset_playground_url,
+      command_line: '--docset-playground-url URL',
+      description: 'URL of an interactive playground to demonstrate the '\
+                   'framework, linked to from the docset.'
+
     # ──────── Doc generation options ────────
     config_attr :disable_search,
       command_line: '--disable-search',

data/lib/jazzy/docset_builder.rb

@@ -43,6 +43,8 @@ module Jazzy
             template.read,
             lowercase_name: source_module.name.downcase,
             name: source_module.name,
+            root_url: config.root_url,
+            playground_url: config.docset_playground_url,
           )
         end
       end

data/lib/jazzy/docset_builder/info_plist.mustache

@@ -16,5 +16,13 @@
       <true/>
     <key>DashDocSetFamily</key>
       <string>dashtoc</string>
+    {{#root_url}}
+    <key>DashDocSetFallbackURL</key>
+      <string>{{{.}}}</string>
+    {{/root_url}}
+    {{#playground_url}}
+    <key>DashDocSetPlayURL</key>
+      <string>{{{.}}}</string>
+    {{/playground_url}}
   </dict>
 </plist>

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/podspec_documenter.rb

@@ -18,8 +18,7 @@ module Jazzy
       Pod::Config.instance.with_changes(installation_root: installation_root,
                                         verbose: false) do
         sandbox = Pod::Sandbox.new(Pod::Config.instance.sandbox_root)
-        swift_version = compiler_swift_version(config.swift_version)
-        installer = Pod::Installer.new(sandbox, podfile(swift_version))
+        installer = Pod::Installer.new(sandbox, podfile(config))
         installer.install!
         stdout = Dir.chdir(sandbox.root) do
           targets = installer.pod_targets
@@ -45,31 +44,39 @@ module Jazzy
 
     # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength
     def self.apply_config_defaults(podspec, config)
       return unless podspec
 
       unless config.author_name_configured
         config.author_name = author_name(podspec)
+        config.author_name_configured = true
       end
       unless config.module_name_configured
         config.module_name = podspec.module_name
+        config.module_name_configured = true
       end
       unless config.author_url_configured
         config.author_url = podspec.homepage || github_file_prefix(podspec)
+        config.author_url_configured = true
       end
       unless config.version_configured
         config.version = podspec.version.to_s
+        config.version_configured = true
       end
       unless config.github_file_prefix_configured
         config.github_file_prefix = github_file_prefix(podspec)
+        config.github_file_prefix_configured = true
       end
       unless config.swift_version_configured
         trunk_swift_build = podspec.attributes_hash['pushed_with_swift_version']
         config.swift_version = trunk_swift_build if trunk_swift_build
+        config.swift_version_configured = true
       end
     end
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength
 
     private
 
@@ -135,10 +142,15 @@ module Jazzy
     end
 
     # rubocop:disable Metrics/MethodLength
-    def podfile(swift_version)
+    def podfile(config)
+      swift_version = compiler_swift_version(config.swift_version)
       podspec = @podspec
       path = pod_path
       @podfile ||= Pod::Podfile.new do
+        config.pod_sources.each do |src|
+          source src
+        end
+
         install! 'cocoapods',
                  integrate_targets: false,
                  deterministic_uuids: false

data/lib/jazzy/sourcekitten.rb

@@ -17,7 +17,7 @@ ELIDED_AUTOLINK_TOKEN = '36f8f5912051ae747ef441d6511ca4cb'.freeze
 def autolink_regex(middle_regex, after_highlight)
   start_tag_re, end_tag_re =
     if after_highlight
-      [/<span class="(?:n|kt|nc)">/, '</span>']
+      [/<span class="(?:n|kt|kd|nc)">/, '</span>']
     else
       ['<code>', '</code>']
     end
@@ -913,9 +913,9 @@ module Jazzy
     # The `after_highlight` flag is used to differentiate between the two modes.
     def self.autolink_text(text, doc, root_decls, after_highlight = false)
       text.autolink_block(doc.url, '[^\s]+', after_highlight) do |raw_name|
-        parts = raw_name
-                .split(/(?<!\.)\.(?!\.)/) # dot with no neighboring dots
-                .reject(&:empty?)
+        parts = raw_name.sub(/^@/, '') # ignore for custom attribute ref
+                        .split(/(?<!\.)\.(?!\.)/) # dot with no neighboring dots
+                        .reject(&:empty?)
 
         # First dot-separated component can match any ancestor or top-level doc
         first_part = parts.shift

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.13.3
 platform: ruby
 authors:
 - JP Simard
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2020-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods