jazzy 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b011225bb2035eea33feeb28e4380677670fc690
-  data.tar.gz: 2f8a49403fd26b3e0d14508046395e63bde5720c
+  metadata.gz: 3bdc6c255a16e1b1494039f0761ed607e0a6dc75
+  data.tar.gz: 46315c068326227766dc54f87f292c21c76d1e78
 SHA512:
-  metadata.gz: 61f1e5776b51822988882f207f74ea08f28d5be662ffe2189567a2221c7b92fb76b32c682d8fbf0a06a03838caaf6f9002488051e3eb919b8a4b63c076a4261f
-  data.tar.gz: 2ce8c0525ffe80a1640e0fe2bf35c0a2c7ba7791de8f5a7a672f77916d2a3c96e5107a69b41b15177408e55a66bda6e213c1e9a19eaa9a5b4f332f644466085e
+  metadata.gz: 57a1884009cb79217841982ce9b25ddf12a1085cf8c0d8b1b8f7be456b8b18f913e11e81dc4b87adc68e606c8d8fd32c72ab223080fe06725cc2815a0b2619ca
+  data.tar.gz: 853465acf5e3be80f3c026d9782711bb8dfd25459860a19e128c6ae71912f2b897b0dc116c1f86dfd17fe3f0d2b652535895922e86e75b8a058fd81f0458c38c

data/.rubocop.yml

@@ -60,6 +60,9 @@ TrailingCommaInArguments:
 Style/SpecialGlobalVars:
   Enabled: false
 
+Style/MultilineBlockChain:
+  Enabled: false
+
 # We prefer explicit `a, _ = arr` to `a, = arr` (which could be misread as a stray comma)
 Style/TrailingUnderscoreVariable:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+## 0.7.0
+
+##### Breaking
+
+* The `docset_platform` option is no longer available. The module name will
+  now be used instead of `jazzy`.  
+  [JP Simard](https://github.com/jpsim)
+  [#423](https://github.com/realm/jazzy/issues/423)
+
+##### Enhancements
+
+* Improved auto-linking behavior to link declarations within declarations and
+  fix cases where declarations would link to themselves or their current page.  
+  [Esad Hajdarevic](https://github.com/esad)
+  [#483](https://github.com/realm/jazzy/issues/483)
+
+##### Bug Fixes
+
+* Fix issue where single-line declaration + bodies in Swift would include the
+  body in the parsed declaration.  
+  [JP Simard](https://github.com/jpsim)
+  [#226](https://github.com/realm/jazzy/issues/226)
+
+* Fix issue where some sections would become empty when using custom groups.  
+  [JP Simard](https://github.com/jpsim)
+  [#475](https://github.com/realm/jazzy/issues/475)
+
+* Fix issue where directories ending with `.swift` would be considered Swift
+  source files.  
+  [JP Simard](https://github.com/jpsim)
+  [#586](https://github.com/realm/jazzy/issues/586)
+
 ## 0.6.3
 
 ##### Breaking

data/Gemfile.lock

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

data/lib/jazzy/config.rb

@@ -212,8 +212,6 @@ module Jazzy
       parse: ->(ps) { PodspecDocumenter.create_podspec(Pathname(ps)) if ps },
       default: Dir['*.podspec{,.json}'].first
 
-    config_attr :docset_platform, default: 'jazzy'
-
     config_attr :docset_icon,
       command_line: '--docset-icon FILEPATH',
       parse: ->(di) { expand_path(di) }

data/lib/jazzy/docset_builder.rb

@@ -41,9 +41,8 @@ module Jazzy
           template = Pathname(__dir__) + 'docset_builder/info_plist.mustache'
           plist << Mustache.render(
             template.read,
-            bundle_identifier: source_module.name.downcase,
+            lowercase_name: source_module.name.downcase,
             name: source_module.name,
-            platform_family: config.docset_platform,
           )
         end
       end

data/lib/jazzy/docset_builder/info_plist.mustache

@@ -3,11 +3,11 @@
 <plist version="1.0">
   <dict>
     <key>CFBundleIdentifier</key>
-      <string>com.jazzy.{{bundle_identifier}}</string>
+      <string>com.jazzy.{{lowercase_name}}</string>
     <key>CFBundleName</key>
       <string>{{name}}</string>
     <key>DocSetPlatformFamily</key>
-      <string>{{platform_family}}</string>
+      <string>{{lowercase_name}}</string>
     <key>isDashDocset</key>
       <true/>
     <key>dashIndexFilePath</key>

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/sourcekitten.rb

@@ -54,6 +54,7 @@ module Jazzy
     end
 
     def self.make_group(group, name, abstract)
+      group.reject! { |doc| doc.name.empty? }
       SourceDeclaration.new.tap do |sd|
         sd.type     = SourceDeclaration::Type.overview
         sd.name     = name
@@ -446,10 +447,26 @@ module Jazzy
       doc
     end
 
-    def self.autolink_text(text, doc, root_decls)
-      text.gsub(%r{<code>[ \t]*([^\s]+)[ \t]*</code>}) do
+    # Links recognized top-level declarations within
+    # - inlined code within docs
+    # - method signatures after they've been processed by the highlighter
+    #
+    # The `after_highlight` flag is used to differentiate between the two modes.
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def self.autolink_text(text, doc, root_decls, after_highlight = false)
+      start_tag_re, end_tag_re =
+        if after_highlight
+          [/<span class="(?:n|kt)">/, '</span>']
+        else
+          ['<code>', '</code>']
+        end
+
+      text.gsub(/(#{start_tag_re})[ \t]*([^\s]+)[ \t]*(#{end_tag_re})/) do
         original = Regexp.last_match(0)
-        raw_name = Regexp.last_match(1)
+        start_tag, raw_name, end_tag = Regexp.last_match.captures
+
         parts = raw_name
                 .split(/(?<!\.)\.(?!\.)/) # dot with no neighboring dots
                 .reject(&:empty?)
@@ -462,34 +479,53 @@ module Jazzy
         # Traverse children via subsequence components, if any
         link_target = name_traversal(parts, name_root)
 
-        if link_target && link_target.url && link_target.url != doc.url
-          "<code><a href=\"#{ELIDED_AUTOLINK_TOKEN}#{link_target.url}\">" +
-            raw_name + '</a></code>'
+        if link_target &&
+           !link_target.type.extension? &&
+           link_target.url &&
+           link_target.url != doc.url.split('#').first && # Don't link to parent
+           link_target.url != doc.url # Don't link to self
+          start_tag +
+            "<a href=\"#{ELIDED_AUTOLINK_TOKEN}#{link_target.url}\">" +
+            raw_name + '</a>' + end_tag
         else
           original
         end
       end
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength
 
     def self.autolink(docs, root_decls)
       docs.each do |doc|
-        doc.abstract = autolink_text(doc.abstract, doc, root_decls)
-        doc.return = autolink_text(doc.return, doc, root_decls) if doc.return
         doc.children = autolink(doc.children, root_decls)
+
+        doc.return = autolink_text(doc.return, doc, root_decls) if doc.return
+        doc.abstract = autolink_text(doc.abstract, doc, root_decls)
+
+        doc.declaration = autolink_text(
+          doc.declaration, doc, root_decls, true
+        ) if doc.declaration
+
+        doc.other_language_declaration = autolink_text(
+          doc.other_language_declaration, doc, root_decls, true
+        ) if doc.other_language_declaration
       end
     end
 
     def self.reject_objc_types(docs)
-      enums = docs.flat_map do |doc|
-        doc.children.select { |child| child.type.objc_enum? }.map(&:name)
-      end
+      enums = docs.map do |doc|
+        [doc, doc.children]
+      end.flatten.select { |child| child.type.objc_enum? }.map(&:name)
       docs.map do |doc|
         doc.children = doc.children.reject do |child|
           child.type.objc_typedef? && enums.include?(child.name)
         end
         doc
+      end.reject do |doc|
+        doc.type.objc_unexposed? ||
+          (doc.type.objc_typedef? && enums.include?(doc.name))
       end
-      docs.reject { |doc| doc.type.objc_unexposed? }
     end
 
     # Parse sourcekitten STDOUT output as JSON
@@ -499,8 +535,7 @@ module Jazzy
       @skip_undocumented = skip_undocumented
       sourcekitten_json = filter_excluded_files(JSON.parse(sourcekitten_output))
       docs = make_source_declarations(sourcekitten_json).concat inject_docs
-      docs = ungrouped_docs = deduplicate_declarations(docs)
-      docs = group_docs(docs)
+      docs = deduplicate_declarations(docs)
       if Config.instance.objc_mode
         docs = reject_objc_types(docs)
       else
@@ -508,6 +543,8 @@ module Jazzy
         # than min_acl
         docs = docs.reject { |doc| doc.type.swift_enum_element? }
       end
+      ungrouped_docs = docs
+      docs = group_docs(docs)
       make_doc_urls(docs)
       autolink(docs, ungrouped_docs)
       [docs, doc_coverage, @undocumented_tokens]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-09 00:00:00.000000000 Z
+date: 2016-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods