jazzy 0.15.3 → 0.15.4

data/lib/jazzy/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jazzy
-  VERSION = '0.15.3' unless defined? Jazzy::VERSION
+  VERSION = '0.15.4' unless defined? Jazzy::VERSION
 end

data/lib/jazzy/grouper.rb

@@ -49,22 +49,18 @@ module Jazzy
 
     def self.group_custom_categories(docs, doc_index)
       group = config.custom_categories.map do |category|
-        children = category['children'].map do |name|
-          unless doc = doc_index.lookup(name)
-            warn 'WARNING: No documented top-level declarations match ' \
-              "name \"#{name}\" specified in categories file"
-            next nil
+        children = category['children'].map do |selector|
+          selected = select_docs(doc_index, selector)
+          selected.map do |doc|
+            unless doc.parent_in_code.nil?
+              warn "WARNING: Declaration \"#{doc.fully_qualified_module_name}\" " \
+                'specified in categories file exists but is not top-level and ' \
+                'cannot be included here'
+              next nil
+            end
+            docs.delete(doc)
           end
-
-          unless doc.parent_in_code.nil?
-            warn "WARNING: Declaration \"#{doc.fully_qualified_module_name}\" " \
-              'specified in categories file exists but is not top-level and ' \
-              'cannot be included here'
-            next nil
-          end
-
-          docs.delete(doc)
-        end.compact
+        end.flatten.compact
         # Category config overrides alphabetization
         children.each.with_index { |child, i| child.nav_order = i }
         make_group(children, category['name'], '')
@@ -72,6 +68,20 @@ module Jazzy
       [group.compact, docs]
     end
 
+    def self.select_docs(doc_index, selector)
+      if selector.is_a?(String)
+        unless single_doc = doc_index.lookup(selector)
+          warn 'WARNING: No documented top-level declarations match ' \
+            "name \"#{selector}\" specified in categories file"
+          return []
+        end
+        [single_doc]
+      else
+        doc_index.lookup_regex(selector['regex'])
+          .sort_by(&:name)
+      end
+    end
+
     def self.group_guides(docs, prefix)
       guides, others = docs.partition { |doc| doc.type.markdown? }
       return [[], others] unless guides.any?

data/lib/jazzy/podspec_documenter.rb

@@ -103,10 +103,12 @@ module Jazzy
 
     # Latest valid value for SWIFT_VERSION.
     LATEST_SWIFT_VERSION = '6'
+    private_constant :LATEST_SWIFT_VERSION
 
     # All valid values for SWIFT_VERSION that are longer
     # than a major version number.  Ordered ascending.
     LONG_SWIFT_VERSIONS = ['4.2'].freeze
+    private_constant :LONG_SWIFT_VERSIONS
 
     # Go from a full Swift version like 4.2.1 to
     # something valid for SWIFT_VERSION.

data/lib/jazzy/source_declaration/type.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'active_support'
 require 'active_support/inflector'
 
@@ -148,8 +149,8 @@ module Jazzy
       def param?
         # SourceKit strangely categorizes initializer parameters as local
         # variables, so both kinds represent a parameter in jazzy.
-        kind == 'source.lang.swift.decl.var.parameter' ||
-          kind == 'source.lang.swift.decl.var.local'
+        ['source.lang.swift.decl.var.parameter',
+         'source.lang.swift.decl.var.local'].include?(kind)
       end
 
       def generic_type_param?

data/lib/jazzy/source_declaration.rb

@@ -98,7 +98,7 @@ module Jazzy
     end
 
     def swift_objc_extension?
-      type.swift_extension? && usr && usr.start_with?('c:objc')
+      type.swift_extension? && usr&.start_with?('c:objc')
     end
 
     def swift_extension_objc_name
@@ -256,6 +256,21 @@ module Jazzy
       notes.join(', ').upcase_first unless notes.empty?
     end
 
+    # For matching where `Self` is equivalent without considering
+    # constraints
+    def simplified_typename
+      typename&.gsub(/<Self .*?>/, '<Self>')
+    end
+
+    # Is the candidate `SourceDeclaration` probably a default
+    # implementation of this declaration?
+    def default_implementation?(candidate)
+      name == candidate.name &&
+        type == candidate.type &&
+        simplified_typename == candidate.simplified_typename &&
+        async == candidate.async
+    end
+
     def readme?
       false
     end

data/lib/jazzy/sourcekitten.rb

@@ -739,18 +739,19 @@ module Jazzy
       mod_key = module_deduplication_key(decl)
       # Swift extension of objc class
       if decl.swift_objc_extension?
-        [decl.swift_extension_objc_name, :objc_class_and_categories, mod_key]
+        [decl.swift_extension_objc_name, nil, :objc_class_and_categories, mod_key]
       # Swift type or Swift extension of Swift type
       elsif mergeable_swift?(decl)
-        [decl.usr, decl.name, mod_key]
+        [decl.usr, nil, decl.name, mod_key]
       # Objc categories and classes
       elsif mergeable_objc?(decl, root_decls)
         # Using the ObjC name to match swift_objc_extension.
         name, _ = decl.objc_category_name || decl.objc_name
-        [name, :objc_class_and_categories, mod_key]
+        [name, nil, :objc_class_and_categories, mod_key]
       # Non-mergable declarations (funcs, typedefs etc...)
       else
-        [decl.usr, decl.name, decl.type.kind, '']
+        # The typename part works around a Swift bug, jazzy#1396
+        [decl.usr, decl.typename, decl.name, decl.type.kind, '']
       end
     end
 
@@ -826,14 +827,17 @@ module Jazzy
       # type itself, the type must be private and the extensions
       # should be rejected.
       if !typedecl &&
-         wanted_exts.first &&
-         wanted_exts.first.type_from_doc_module?
+         wanted_exts.first&.type_from_doc_module?
         unwanted_exts += wanted_exts
         wanted_exts = []
       end
 
-      # Don't tell the user to document them
-      unwanted_exts.each { |e| @stats.remove_undocumented(e) }
+      # Don't tell the user to document them or their contents
+      remover = lambda do |decls|
+        decls.each { |d| @stats.remove_undocumented(d) }
+        decls.map(&:children).each { |c| remover[c] }
+      end
+      remover[unwanted_exts]
 
       objc_exts + wanted_exts
     end
@@ -853,9 +857,7 @@ module Jazzy
       extensions.each do |ext|
         ext.children = ext.children.select do |ext_member|
           proto_member = protocol.children.find do |p|
-            p.name == ext_member.name &&
-              p.type == ext_member.type &&
-              p.async == ext_member.async
+            p.default_implementation?(ext_member)
           end
 
           # Extension-only method, keep.

data/lib/jazzy/symbol_graph/constraint.rb

@@ -17,13 +17,14 @@ module Jazzy
         self.rhs = rhs
       end
 
-      public
-
       KIND_MAP = {
         'conformance' => ':',
         'superclass' => ':',
         'sameType' => '==',
       }.freeze
+      private_constant :KIND_MAP
+
+      public
 
       # Init from a JSON hash
       def self.new_hash(hash)

data/lib/jazzy/symbol_graph/graph.rb

@@ -100,7 +100,7 @@ module Jazzy
                              source.unique_context_constraints(target))
 
         # Add to its parent or invent an extension
-        unless target&.try_add_child(source, constraints.ext)
+        unless target&.add_child?(source, constraints.ext)
           add_ext_member(rel.target_usr, source, constraints)
         end
       end

data/lib/jazzy/symbol_graph/sym_node.rb

@@ -76,7 +76,7 @@ module Jazzy
       # It must go in an extension if either:
       #  - it has different generic constraints to us; or
       #  - we're a protocol and it's a default impl / ext method
-      def try_add_child(node, unique_context_constraints)
+      def add_child?(node, unique_context_constraints)
         unless unique_context_constraints.empty? &&
                (!protocol? || node.protocol_requirement?)
           return false

metadata

@@ -1,18 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.15.3
+  version: 0.15.4
 platform: ruby
 authors:
 - JP Simard
 - Tim Anglade
 - Samuel Giddins
 - John Fairhurst
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: cocoapods
   requirement: !ruby/object:Gem::Requirement
@@ -27,6 +46,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
@@ -367,7 +400,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -382,8 +414,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Soulful docs for Swift & Objective-C.
 test_files: []