Module: Jazzy::SourceKitten

Defined in:
lib/jazzy/sourcekitten.rb

Overview

This module interacts with the sourcekitten command-line executable

Constant Summary collapse

DEFAULT_ATTRIBUTES =

Strip default property attributes because libclang adds them all, even if absent in the original source code.

%w[atomic readwrite assign unsafe_unretained].freeze
AUTOLINK_TEXT_FIELDS = 
%w[return
abstract
unavailable_message
deprecation_message].freeze
%w[declaration
other_language_declaration].freeze

Class Method Summary collapse

Class Method Details

.arguments_from_options(module_config) ⇒ Object

Builds SourceKitten arguments based on Jazzy options



182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/jazzy/sourcekitten.rb', line 182

def self.arguments_from_options(module_config)
  arguments = ['doc']
  if module_config.objc_mode
    arguments += objc_arguments_from_options(module_config)
  else
    arguments += ['--spm'] if use_spm?(module_config)
    unless module_config.module_name.empty?
      arguments += ['--module-name', module_config.module_name]
    end
    arguments += ['--']
  end

  arguments + module_config.build_tool_arguments
end

.attribute?(doc, attr_name) ⇒ Boolean

Returns:

  • (Boolean) 


244
245
246
247
248
 
# File 'lib/jazzy/sourcekitten.rb', line 244

def self.attribute?(doc, attr_name)
  doc['key.attributes']&.find do |attribute|
    attribute['key.attribute'] == "source.decl.attribute.#{attr_name}"
  end
end

.attribute_regexp(name) ⇒ Object

Regexp to match an @attribute. Complex to handle @available().



398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/jazzy/sourcekitten.rb', line 398

def self.attribute_regexp(name)
  qstring = /"(?:[^"\\]*|\\.)*"/
  %r{@#{name}      # @attr name
    (?:\s*\(       # optionally followed by spaces + parens,
      (?:          # containing any number of either..
        [^")]*|    # normal characters or...
        #{qstring} # quoted strings.
      )*           # (end parens content)
    \))?           # (end optional parens)
  }x
end

.autolink(docs) ⇒ Object 



993
994
995
996
997
998
999
 
# File 'lib/jazzy/sourcekitten.rb', line 993

def self.autolink(docs)
  docs.each do |doc|
    doc.children = autolink(doc.children)
    autolink_text_fields(doc)
    autolink_highlight_fields(doc)
  end
end

.autolink_document(html, doc) ⇒ Object

For autolinking external markdown documents



1002
1003
1004
 
# File 'lib/jazzy/sourcekitten.rb', line 1002

def self.autolink_document(html, doc)
  autolink_text(html, doc)
end

.autolink_highlight_fields(doc) ⇒ Object 



984
985
986
987
988
989
990
991
 
# File 'lib/jazzy/sourcekitten.rb', line 984

def self.autolink_highlight_fields(doc)
  AUTOLINK_HIGHLIGHT_FIELDS.each do |field|
    if text = doc.send(field)
      doc.send(field + '=',
               autolink_text(text, doc, after_highlight: true))
    end
  end
end

.autolink_text(text, doc, after_highlight: false) ⇒ Object

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.

DocC link format - follow Xcode and don’t display slash-separated parts.



949
950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'lib/jazzy/sourcekitten.rb', line 949

def self.autolink_text(text, doc, after_highlight: false)
  text.autolink_block(doc.url, '[^\s]+', after_highlight) do |raw_name|
    sym_name =
      (raw_name[/^<doc:(.*)>$/, 1] || raw_name).sub(/(?<!^)-.+$/, '')

    [@doc_index.lookup(sym_name, doc), sym_name.sub(%r{^.*/}, '')]
  end.autolink_block(doc.url, '[+-]\[\w+(?: ?\(\w+\))? [\w:]+\]',
                     after_highlight) do |raw_name|
    [@doc_index.lookup(raw_name, doc), raw_name]
  end.autolink_block(doc.url, '[+-]\w[\w:]*', after_highlight) do |raw_name|
    [@doc_index.lookup(raw_name, doc), raw_name]
  end
end

.autolink_text_fields(doc) ⇒ Object 



968
969
970
971
972
973
974
975
976
977
978
979
 
# File 'lib/jazzy/sourcekitten.rb', line 968

def self.autolink_text_fields(doc)
  AUTOLINK_TEXT_FIELDS.each do |field|
    if text = doc.send(field)
      doc.send(field + '=', autolink_text(text, doc))
    end
  end

  (doc.parameters || []).each do |param|
    param[:discussion] =
      autolink_text(param[:discussion], doc)
  end
end

.availability_attribute?(doc) ⇒ Boolean

Returns:

  • (Boolean) 


250
251
252
 
# File 'lib/jazzy/sourcekitten.rb', line 250

def self.availability_attribute?(doc)
  attribute?(doc, 'available')
end

.deduplicate_declarations(declarations) ⇒ Object

Merges multiple extensions of the same entity into a single document.

Merges extensions into the protocol/class/struct/enum they extend, if it occurs in the same project.

Merges redundant declarations when documenting podspecs.



679
680
681
682
683
684
685
686
687
688
 
# File 'lib/jazzy/sourcekitten.rb', line 679

def self.deduplicate_declarations(declarations)
  duplicate_groups = declarations
    .group_by { |d| deduplication_key(d, declarations) }
    .values

  duplicate_groups.flat_map do |group|
    # Put extended type (if present) before extensions
    merge_declarations(group)
  end.compact
end

.deduplication_key(decl, root_decls) ⇒ Object

Two declarations get merged if they have the same deduplication key.



729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/jazzy/sourcekitten.rb', line 729

def self.deduplication_key(decl, root_decls)
  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]
  # Swift type or Swift extension of Swift type
  elsif mergeable_swift?(decl)
    [decl.usr, 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]
  # Non-mergable declarations (funcs, typedefs etc...)
  else
    [decl.usr, decl.name, decl.type.kind, '']
  end
end

.expand_extension(extension, name_parts, decls) ⇒ Object 



652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/jazzy/sourcekitten.rb', line 652

def self.expand_extension(extension, name_parts, decls)
  return extension if name_parts.empty?

  name = name_parts.shift
  candidates = decls.select { |decl| decl.name == name }
  SourceDeclaration.new.tap do |decl|
    make_default_doc_info(decl)
    decl.name = name
    decl.module_name = extension.module_name
    decl.doc_module_name = extension.doc_module_name
    decl.type = extension.type
    decl.mark = extension.mark
    decl.usr = candidates.first.usr unless candidates.empty?
    child = expand_extension(extension,
                             name_parts,
                             candidates.flat_map(&:children).uniq)
    child.parent_in_code = decl
    decl.children = [child]
  end
end

.expand_extensions(decls) ⇒ Object

Expands extensions of nested types declared at the top level into a tree so they can be deduplicated properly



638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/jazzy/sourcekitten.rb', line 638

def self.expand_extensions(decls)
  decls.map do |decl|
    next decl unless decl.type.extension? && decl.name.include?('.')

    # Don't expand the Swift namespace if we're in ObjC mode.
    # ex: NS_SWIFT_NAME(Foo.Bar) should not create top-level Foo
    next decl if decl.swift_objc_extension? && !Config.instance.hide_objc?

    name_parts = decl.name.split('.')
    decl.name = name_parts.pop
    expand_extension(decl, name_parts, decls)
  end
end

.extract_attributes(declaration, name = '\w+') ⇒ Object

Get all attributes of some name



411
412
413
414
415
 
# File 'lib/jazzy/sourcekitten.rb', line 411

def self.extract_attributes(declaration, name = '\w+')
  attrs = declaration.scan(attribute_regexp(name))
  # Rouge #806 workaround, use unicode lookalike for ')' inside attributes.
  attrs.map { |str| str.gsub(/\)(?!\s*$)/, "\ufe5a") }
end

.extract_availability(declaration) ⇒ Object 



424
425
426
 
# File 'lib/jazzy/sourcekitten.rb', line 424

def self.extract_availability(declaration)
  extract_attributes(declaration, 'available')
end

.extract_documented_attributes(declaration) ⇒ Object

Keep everything except instructions to us



418
419
420
421
422
 
# File 'lib/jazzy/sourcekitten.rb', line 418

def self.extract_documented_attributes(declaration)
  extract_attributes(declaration).reject do |attr|
    attr.start_with?('@_documentation')
  end
end

.filter_excluded_files(json) ⇒ Object

Filter based on the “excluded” flag.



1032
1033
1034
1035
1036
1037
1038
1039
1040
 
# File 'lib/jazzy/sourcekitten.rb', line 1032

def self.filter_excluded_files(json)
  excluded_files = Config.instance.excluded_files
  json.map do |doc|
    key = doc.keys.first
    doc unless excluded_files.detect do |exclude|
      File.fnmatch?(exclude, key)
    end
  end.compact
end

.filter_files(json) ⇒ Object

Apply filtering based on the “included” and “excluded” flags.



1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'lib/jazzy/sourcekitten.rb', line 1011

def self.filter_files(json)
  json = filter_included_files(json) if Config.instance.included_files.any?
  json = filter_excluded_files(json) if Config.instance.excluded_files.any?
  json.map do |doc|
    key = doc.keys.first
    doc[key]
  end.compact
end

.filter_included_files(json) ⇒ Object

Filter based on the “included” flag.



1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'lib/jazzy/sourcekitten.rb', line 1021

def self.filter_included_files(json)
  included_files = Config.instance.included_files
  json.map do |doc|
    key = doc.keys.first
    doc if included_files.detect do |include|
      File.fnmatch?(include, key)
    end
  end.compact
end

.find_generic_requirements(parsed_declaration) ⇒ Object

rubocop:enable Metrics/PerceivedComplexity rubocop:enable Metrics/CyclomaticComplexity rubocop:enable Metrics/MethodLength



625
626
627
628
629
630
 
# File 'lib/jazzy/sourcekitten.rb', line 625

def self.find_generic_requirements(parsed_declaration)
  parsed_declaration =~ /\bwhere\s+(.*)$/m
  return nil unless Regexp.last_match

  Regexp.last_match[1].gsub(/\s+/, ' ')
end

.fix_up_compiler_decl(annotated_decl, declaration) ⇒ Object

Apply fixes to improve the compiler’s declaration



446
447
448
449
450
451
452
453
454
455
 
# File 'lib/jazzy/sourcekitten.rb', line 446

def self.fix_up_compiler_decl(annotated_decl, declaration)
  annotated_decl.
    # Replace the fully qualified name of a type with its base name
    gsub(declaration.fully_qualified_name_regexp,
         declaration.name).
    # Workaround for SR-9816
    gsub(" {\n  get\n  }", '').
    # Workaround for SR-12139
    gsub(/mutating\s+mutating/, 'mutating')
end

.highlight_declaration(doc, declaration) ⇒ Object 



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/jazzy/sourcekitten.rb', line 364

def self.highlight_declaration(doc, declaration)
  if declaration.swift?
    declaration.declaration =
      Highlighter.highlight_swift(make_swift_declaration(doc, declaration))
  else
    declaration.declaration =
      Highlighter.highlight_objc(
        make_objc_declaration(doc['key.parsed_declaration']),
      )
    declaration.other_language_declaration =
      Highlighter.highlight_swift(doc['key.swift_declaration'])
  end
end

.make_default_doc_info(declaration) ⇒ Object

SourceDeclaration generation



237
238
239
240
241
242
 
# File 'lib/jazzy/sourcekitten.rb', line 237

def self.make_default_doc_info(declaration)
  # @todo: Fix these
  declaration.abstract = ''
  declaration.parameters = []
  declaration.children = []
end

.make_deprecation_info(doc, declaration) ⇒ Object 



378
379
380
381
382
383
384
385
386
387
 
# File 'lib/jazzy/sourcekitten.rb', line 378

def self.make_deprecation_info(doc, declaration)
  if declaration.deprecated
    declaration.deprecation_message =
      Markdown.render(doc['key.deprecation_message'] || '')
  end
  if declaration.unavailable
    declaration.unavailable_message =
      Markdown.render(doc['key.unavailable_message'] || '')
  end
end

.make_doc_info(doc, declaration) ⇒ Object 



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/jazzy/sourcekitten.rb', line 345

def self.make_doc_info(doc, declaration)
  return unless should_document?(doc)

  highlight_declaration(doc, declaration)
  make_deprecation_info(doc, declaration)

  unless doc['key.doc.full_as_xml']
    return process_undocumented_token(doc, declaration)
  end

  declaration.abstract = Markdown.render(doc['key.doc.comment'] || '',
                                         declaration.highlight_language)
  declaration.discussion = ''
  declaration.return = Markdown.rendered_returns
  declaration.parameters = parameters(doc, Markdown.rendered_parameters)

  @stats.add_documented
end

.make_doc_urls(docs) ⇒ Hash

rubocop:disable Metrics/MethodLength Generate doc URL by prepending its parents’ URLs

Returns:

  • (Hash) —

    input docs with URLs



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/jazzy/sourcekitten.rb', line 82

def self.make_doc_urls(docs)
  docs.each do |doc|
    if doc.render_as_page?
      doc.url = (
        subdir_for_doc(doc) +
        [sanitize_filename(doc) + '.html']
      ).map { |path| ERB::Util.url_encode(path) }.join('/')
      doc.children = make_doc_urls(doc.children)
    else
      # Don't create HTML page for this doc if it doesn't have children
      # Instead, make its link a hash-link on its parent's page
      if doc.typename == '<<error type>>'
        warn "A compile error prevented #{doc.fully_qualified_name} " \
          'from receiving a unique USR. Documentation may be ' \
          'incomplete. Please check for compile errors by running ' \
          '`xcodebuild` or `swift build` with arguments ' \
          "`#{Config.instance.build_tool_arguments.shelljoin}`."
      end
      id = doc.usr
      unless id
        id = doc.name || 'unknown'
        warn "`#{id}` has no USR. First make sure all modules used in " \
          'your project have been imported. If all used modules are ' \
          'imported, please report this problem by filing an issue at ' \
          'https://github.com/realm/jazzy/issues along with your ' \
          'Xcode project. If this token is declared in an `#if` block, ' \
          'please ignore this message.'
      end
      doc.url = "#{doc.parent_in_docs.url}#/#{id}"
    end
  end
end

.make_objc_declaration(declaration) ⇒ Object 



504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/jazzy/sourcekitten.rb', line 504

def self.make_objc_declaration(declaration)
  return declaration if Config.instance.keep_property_attributes

  declaration =~ /\A@property\s+\((.*?)\)/
  return declaration unless Regexp.last_match

  attrs = Regexp.last_match[1].split(',').map(&:strip) - DEFAULT_ATTRIBUTES
  attrs_text = attrs.empty? ? '' : " (#{attrs.join(', ')})"

  declaration
    .sub(/(?<=@property)\s+\(.*?\)/, attrs_text)
    .gsub(/\s+/, ' ')
end

.make_source_declarations(docs, parent = nil, mark = SourceMark.new) ⇒ Object

rubocop:disable Metrics/MethodLength rubocop:disable Metrics/CyclomaticComplexity rubocop:disable Metrics/PerceivedComplexity



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'lib/jazzy/sourcekitten.rb', line 529

def self.make_source_declarations(docs, parent = nil, mark = SourceMark.new)
  declarations = []
  current_mark = mark
  Array(docs).each do |doc|
    if doc.key?('key.diagnostic_stage')
      declarations += make_source_declarations(
        doc['key.substructure'], parent
      )
      next
    end
    declaration = SourceDeclaration.new
    declaration.parent_in_code = parent
    declaration.type =
      SourceDeclaration::Type.new(doc['key.kind'],
                                  doc['key.fully_annotated_decl'])
    declaration.typename = doc['key.typename']
    declaration.objc_name = doc['key.name']
    documented_name = if Config.instance.hide_objc? && doc['key.swift_name']
                        doc['key.swift_name']
                      else
                        declaration.objc_name
                      end
    if declaration.type.task_mark?(documented_name)
      current_mark = SourceMark.new(documented_name)
    end
    if declaration.type.swift_enum_case?
      # Enum "cases" are thin wrappers around enum "elements".
      declarations += make_source_declarations(
        doc['key.substructure'], parent, current_mark
      )
      next
    end
    next unless declaration.type.should_document?

    unless declaration.type.name
      raise 'Please file an issue at ' \
        'https://github.com/realm/jazzy/issues about adding support ' \
        "for `#{declaration.type.kind}`."
    end

    unless documented_name
      warn 'Found a declaration without `key.name` that will be ' \
        'ignored.  Documentation may be incomplete.  This is probably ' \
        'caused by unresolved compiler errors: check the sourcekitten ' \
        'output for error messages.'
      next
    end

    declaration.file = Pathname(doc['key.filepath']) if doc['key.filepath']
    declaration.usr = doc['key.usr']
    declaration.type_usr = doc['key.typeusr']
    declaration.module_name =
      if declaration.swift?
        # Filter out Apple sub-framework implementation names
        doc['key.modulename']&.sub(/\..*$/, '')
      else
        # ObjC best effort, category original module is unavailable
        @current_module_name
      end
    declaration.doc_module_name = @current_module_name
    declaration.name = documented_name
    declaration.mark = current_mark
    declaration.access_control_level =
      SourceDeclaration::AccessControlLevel.from_doc(doc)
    declaration.line = doc['key.doc.line'] || doc['key.line']
    declaration.column = doc['key.doc.column'] || doc['key.column']
    declaration.start_line = doc['key.parsed_scope.start']
    declaration.end_line = doc['key.parsed_scope.end']
    declaration.deprecated = doc['key.always_deprecated']
    declaration.unavailable = doc['key.always_unavailable']
    declaration.generic_requirements =
      find_generic_requirements(doc['key.parsed_declaration'])
    inherited_types = doc['key.inheritedtypes'] || []
    declaration.inherited_types =
      inherited_types.map { |type| type['key.name'] }.compact
    declaration.async =
      doc['key.symgraph_async'] ||
      if xml_declaration = doc['key.fully_annotated_decl']
        swift_async?(xml_declaration)
      end

    next unless make_doc_info(doc, declaration)

    declaration.children = make_substructure(doc, declaration)
    next if declaration.type.extension? &&
            declaration.children.empty? &&
            !declaration.inherited_types?

    declarations << declaration
  end
  declarations
end

.make_substructure(doc, declaration) ⇒ Object 



518
519
520
521
522
523
524
 
# File 'lib/jazzy/sourcekitten.rb', line 518

def self.make_substructure(doc, declaration)
  return [] unless subdocs = doc['key.substructure']

  make_source_declarations(subdocs,
                           declaration,
                           declaration.mark_for_children)
end

.make_swift_declaration(doc, declaration) ⇒ Object

Find the best Swift declaration



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/jazzy/sourcekitten.rb', line 458

def self.make_swift_declaration(doc, declaration)
  # From compiler 'quick help' style
  annotated_decl_xml = doc['key.annotated_decl']

  return nil unless annotated_decl_xml

  annotated_decl_attrs, annotated_decl_body =
    split_decl_attributes(xml_to_text(annotated_decl_xml))

  # From source code
  parsed_decl = doc['key.parsed_declaration']

  # Don't present type attributes on extensions
  return parsed_decl if declaration.type.extension?

  decl =
    if prefer_parsed_decl?(parsed_decl,
                           annotated_decl_body,
                           declaration.type)
      # Strip any attrs captured by parsed version
      inline_attrs, parsed_decl_body = split_decl_attributes(parsed_decl)
      parsed_decl_body.unindent(inline_attrs.length)
    else
      # Improve the compiler declaration
      fix_up_compiler_decl(annotated_decl_body, declaration)
    end

  # @available attrs only in compiler 'interface' style
  extract_availability(doc['key.doc.declaration'] || '')
    .concat(extract_documented_attributes(annotated_decl_attrs))
    .push(decl)
    .join("\n")
end

.mark_and_merge_protocol_extensions(protocol, extensions) ⇒ Object

Protocol extensions.

If any of the extensions provide default implementations for methods in the given protocol, merge those members into the protocol doc instead of keeping them on the extension. These get a “Default implementation” annotation in the generated docs. Default implementations added by conditional extensions are annotated but listed separately.

Protocol methods provided only in an extension and not in the protocol itself are a special beast: they do not use dynamic dispatch. These get an “Extension method” annotation in the generated docs.



843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
 
# File 'lib/jazzy/sourcekitten.rb', line 843

def self.mark_and_merge_protocol_extensions(protocol, extensions)
  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
      end

      # Extension-only method, keep.
      unless proto_member
        ext_member.from_protocol_extension = true
        next true
      end

      # Default impl but constrained, mark and keep.
      if ext.constrained_extension?
        ext_member.default_impl_abstract = ext_member.abstract
        ext_member.abstract = nil
        next true
      end

      # Default impl for all users, merge.
      proto_member.default_impl_abstract = ext_member.abstract
      next false
    end
  end
end

.mark_objc_external_categories(docs) ⇒ Object

Spot and mark any categories on classes not declared in these docs



1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
 
# File 'lib/jazzy/sourcekitten.rb', line 1064

def self.mark_objc_external_categories(docs)
  class_names = docs.select { |doc| doc.type.objc_class? }.to_set(&:name)

  docs.map do |doc|
    if (names = doc.objc_category_name) && !class_names.include?(names.first)
      doc.module_name = '(Imported)'
    end
    doc
  end
end

.merge_code_declaration(decls) ⇒ Object

Merge useful information added by extensions into the main declaration: public protocol conformances and, for top-level extensions, further conditional extensions of the same type.



899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'lib/jazzy/sourcekitten.rb', line 899

def self.merge_code_declaration(decls)
  declarations = decls[1..].select do |decl|
    decl.type.swift_extension? &&
      (decl.other_inherited_types?(@inaccessible_protocols) ||
        (decls.first.type.swift_extension? && decl.constrained_extension?))
  end.prepend(decls.first)

  html_declaration = ''
  until declarations.empty?
    module_decls, declarations = next_doc_module_group(declarations)
    first = module_decls.first
    if need_doc_module_note?(first, html_declaration)
      html_declaration += "<span class='declaration-note'>From #{first.doc_module_name}:</span>"
    end
    html_declaration += module_decls.map(&:declaration).uniq.join
  end

  # Must preserve `nil` for edge cases
  decls.first.declaration = html_declaration unless html_declaration.empty?
end

.merge_declarations(decls) ⇒ Object

rubocop:disable Metrics/MethodLength rubocop:disable Metrics/PerceivedComplexity Merges all of the given types and extensions into a single document.



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'lib/jazzy/sourcekitten.rb', line 751

def self.merge_declarations(decls)
  extensions, typedecls = decls.partition { |d| d.type.extension? }

  if typedecls.size > 1
    info = typedecls
      .map { |t| "#{t.type.name.downcase} #{t.name}" }
      .join(', ')
    warn 'Found conflicting type declarations with the same name, which ' \
      "may indicate a build issue or a bug in Jazzy: #{info}"
  end
  typedecl = typedecls.first

  extensions = reject_inaccessible_extensions(typedecl, extensions)

  if typedecl
    if typedecl.type.swift_protocol?
      mark_and_merge_protocol_extensions(typedecl, extensions)
      extensions.reject! { |ext| ext.children.empty? }
    end

    merge_objc_declaration_marks(typedecl, extensions)
  end

  # Keep type-aliases separate from any extensions
  if typedecl&.type&.swift_typealias?
    [merge_type_and_extensions(typedecls, []),
     merge_type_and_extensions([], extensions)]
  else
    merge_type_and_extensions(typedecls, extensions)
  end
end

.merge_objc_declaration_marks(typedecl, extensions) ⇒ Object

Mark children merged from categories with the name of category (unless they already have a mark)



874
875
876
877
878
879
880
881
 
# File 'lib/jazzy/sourcekitten.rb', line 874

def self.merge_objc_declaration_marks(typedecl, extensions)
  return unless typedecl.type.objc_class?

  extensions.each do |ext|
    _, category_name = ext.objc_category_name
    ext.children.each { |c| c.mark.name ||= category_name }
  end
end

.merge_type_and_extensions(typedecls, extensions) ⇒ Object

rubocop:enable Metrics/PerceivedComplexity rubocop:enable Metrics/MethodLength



785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'lib/jazzy/sourcekitten.rb', line 785

def self.merge_type_and_extensions(typedecls, extensions)
  # Constrained extensions at the end
  constrained, regular_exts = extensions.partition(&:constrained_extension?)
  decls = typedecls + regular_exts + constrained
  return nil if decls.empty?

  move_merged_extension_marks(decls)
  merge_code_declaration(decls)

  decls.first.tap do |merged|
    merged.children = deduplicate_declarations(
      decls.flat_map(&:children).uniq,
    )
    merged.children.each do |child|
      child.parent_in_code = merged
    end
  end
end

.mergeable_objc?(decl, root_decls) ⇒ Boolean

Returns true if an Objective-C declaration is mergeable.

Returns:

  • (Boolean) 


691
692
693
694
695
696
 
# File 'lib/jazzy/sourcekitten.rb', line 691

def self.mergeable_objc?(decl, root_decls)
  decl.type.objc_class? ||
    (decl.type.objc_category? &&
      (category_classname = decl.objc_category_name[0]) &&
      root_decls.any? { |d| d.name == category_classname })
end

.mergeable_swift?(decl) ⇒ Boolean

Returns if a Swift declaration is mergeable. Start off merging in typealiases to help understand extensions.

Returns:

  • (Boolean) 


700
701
702
703
704
 
# File 'lib/jazzy/sourcekitten.rb', line 700

def self.mergeable_swift?(decl)
  decl.type.swift_extensible? ||
    decl.type.swift_extension? ||
    decl.type.swift_typealias?
end

.module_deduplication_key(decl) ⇒ Object

Normally merge all extensions into their types and each other.

:none means only merge within a module – so two extensions to

some type get merged, but an extension to a type from
another documented module does not get merged into that type

:extensions means extensions of documented modules get merged,

but if we're documenting ModA and ModB, and they both provide
extensions to Swift.String, then those two extensions still
appear separately.

(The USR part of the dedup key means ModA.Foo and ModB.Foo do not get merged.)



718
719
720
721
722
723
724
725
726
 
# File 'lib/jazzy/sourcekitten.rb', line 718

def self.module_deduplication_key(decl)
  if (Config.instance.merge_modules == :none) ||
     (Config.instance.merge_modules == :extensions &&
      decl.extension_of_external_type?)
    decl.doc_module_name
  else
    ''
  end
end

.move_merged_extension_marks(decls) ⇒ Object

For each extension to be merged, move any MARK from the extension declaration down to the extension contents so it still shows up.



885
886
887
888
889
890
891
892
893
894
 
# File 'lib/jazzy/sourcekitten.rb', line 885

def self.move_merged_extension_marks(decls)
  return unless to_be_merged = decls[1..]

  to_be_merged.each do |ext|
    child = ext.children.first
    if child && child.mark.empty?
      child.mark.copy(ext.mark)
    end
  end
end

.need_doc_module_note?(decl, html_declaration) ⇒ Boolean

Does this extension/type need a note explaining which doc module it is from? Only for extensions, if there actually are multiple modules. Last condition avoids it for simple ‘extension Array’.

Returns:

  • (Boolean) 


930
931
932
933
934
935
936
 
# File 'lib/jazzy/sourcekitten.rb', line 930

def self.need_doc_module_note?(decl, html_declaration)
  Config.instance.multiple_modules? &&
    decl.type.swift_extension? &&
    !(html_declaration.empty? &&
      !decl.constrained_extension? &&
      !decl.inherited_types?)
end

.next_doc_module_group(decls) ⇒ Object

Grab all the extensions from the same doc module



921
922
923
924
925
 
# File 'lib/jazzy/sourcekitten.rb', line 921

def self.next_doc_module_group(decls)
  decls.partition do |decl|
    decl.doc_module_name == decls.first.doc_module_name
  end
end

.objc_arguments_from_options(module_config) ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/jazzy/sourcekitten.rb', line 197

def self.objc_arguments_from_options(module_config)
  arguments = []
  if module_config.build_tool_arguments.empty?
    arguments += ['--objc', module_config.umbrella_header.to_s, '--', '-x',
                  'objective-c', '-isysroot',
                  `xcrun --show-sdk-path --sdk #{module_config.sdk}`.chomp,
                  '-I', module_config.framework_root.to_s,
                  '-fmodules']
  end
  # add additional -I arguments for each subdirectory of framework_root
  unless module_config.framework_root.nil?
    rec_path(Pathname.new(module_config.framework_root.to_s)).collect do |child|
      if child.directory?
        arguments += ['-I', child.to_s]
      end
    end
  end
  arguments
end

.parameters(doc, discovered) ⇒ Object 



335
336
337
338
339
340
341
342
343
 
# File 'lib/jazzy/sourcekitten.rb', line 335

def self.parameters(doc, discovered)
  (doc['key.doc.parameters'] || []).map do |p|
    name = p['name']
    {
      name: name,
      discussion: discovered[name],
    }
  end.reject { |param| param[:discussion].nil? }
end

.parse(sourcekitten_output, options, inject_docs) ⇒ Hash

Parse sourcekitten STDOUT output as JSON

Returns:

  • (Hash) —

    structured docs



1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
 
# File 'lib/jazzy/sourcekitten.rb', line 1077

def self.parse(sourcekitten_output, options, inject_docs)
  @min_acl = options.min_acl
  @skip_undocumented = options.skip_undocumented
  @stats = Stats.new
  @inaccessible_protocols = []

  # Process each module separately to inject the source module name
  docs = sourcekitten_output.zip(options.module_names).map do |json, name|
    @current_module_name = name
    sourcekitten_dicts = filter_files(JSON.parse(json).flatten)
    make_source_declarations(sourcekitten_dicts)
  end.flatten + inject_docs

  docs = expand_extensions(docs)
  docs = deduplicate_declarations(docs)
  docs = reject_objc_types(docs)
  docs = reject_swift_types(docs)
  docs = mark_objc_external_categories(docs)

  @doc_index = DocIndex.new(docs)

  docs = Grouper.group_docs(docs, @doc_index)

  make_doc_urls(docs)
  autolink(docs)
  [docs, @stats]
end

.prefer_parsed_decl?(parsed, annotated, type) ⇒ Boolean

Returns:

  • (Boolean) 


434
435
436
437
438
439
440
441
442
443
 
# File 'lib/jazzy/sourcekitten.rb', line 434

def self.prefer_parsed_decl?(parsed, annotated, type)
  return true if annotated.empty?
  return false unless parsed
  return false if type.swift_variable? # prefer { get }-style

  annotated.include?(' = default') || # SR-2608
    (parsed.scan(/@autoclosure|@escaping/).count >
     annotated.scan(/@autoclosure|@escaping/).count) || # SR-6321
    parsed.include?("\n") # user formatting
end

.process_undocumented_token(doc, declaration) ⇒ Object 



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/jazzy/sourcekitten.rb', line 319

def self.process_undocumented_token(doc, declaration)
  make_default_doc_info(declaration)

  if declaration.mark_undocumented?
    @stats.add_undocumented(declaration)
    return nil if @skip_undocumented

    declaration.abstract = undocumented_abstract
  else
    declaration.abstract = Markdown.render(doc['key.doc.comment'] || '',
                                           declaration.highlight_language)
  end

  declaration
end

.rec_path(path) ⇒ Object

returns all subdirectories of specified path



165
166
167
168
169
170
171
 
# File 'lib/jazzy/sourcekitten.rb', line 165

def self.rec_path(path)
  path.children.collect do |child|
    if child.directory?
      rec_path(child) + [child]
    end
  end.select { |x| x }.flatten(1)
end

.reject_inaccessible_extensions(typedecl, extensions) ⇒ Object

Now we know all the public types and all the private protocols, reject extensions that add public protocols to private types or add private protocols to public types.



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'lib/jazzy/sourcekitten.rb', line 807

def self.reject_inaccessible_extensions(typedecl, extensions)
  swift_exts, objc_exts = extensions.partition(&:swift?)

  # Reject extensions that are just conformances to private protocols
  unwanted_exts, wanted_exts = swift_exts.partition do |ext|
    ext.children.empty? &&
      !ext.other_inherited_types?(@inaccessible_protocols)
  end

  # Given extensions of a type from this module, without the
  # 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?
    unwanted_exts += wanted_exts
    wanted_exts = []
  end

  # Don't tell the user to document them
  unwanted_exts.each { |e| @stats.remove_undocumented(e) }

  objc_exts + wanted_exts
end

.reject_objc_types(docs) ⇒ Object 



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'lib/jazzy/sourcekitten.rb', line 1042

def self.reject_objc_types(docs)
  enums = docs.map do |doc|
    [doc, doc.children]
  end.flatten.select { |child| child.type.objc_enum? }.map(&:objc_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
end

.reject_swift_types(docs) ⇒ Object

Remove top-level enum cases because it means they have an ACL lower than min_acl



1059
1060
1061
 
# File 'lib/jazzy/sourcekitten.rb', line 1059

def self.reject_swift_types(docs)
  docs.reject { |doc| doc.type.swift_enum_element? }
end

.run_sourcekitten(arguments) ⇒ Object

Run sourcekitten with given arguments and return STDOUT



218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/jazzy/sourcekitten.rb', line 218

def self.run_sourcekitten(arguments)
  if swift_version = Config.instance.swift_version
    unless xcode = XCInvoke::Xcode.find_swift_version(swift_version)
      raise "Unable to find an Xcode with swift version #{swift_version}."
    end

    env = xcode.as_env
  else
    env = ENV
  end
  bin_path = Pathname(__FILE__) + '../../../bin/sourcekitten'
  output, = Executable.execute_command(bin_path, arguments, true, env: env)
  output
end

.sanitize_filename(doc) ⇒ Object

URL assignment



69
70
71
72
73
74
75
76
77
 
# File 'lib/jazzy/sourcekitten.rb', line 69

def self.sanitize_filename(doc)
  unsafe_filename = doc.docs_filename
  sanitzation_enabled = Config.instance.use_safe_filenames
  if sanitzation_enabled && !doc.type.name_controlled_manually?
    CGI.escape(unsafe_filename).gsub('_', '%5F').tr('%', '_')
  else
    unsafe_filename
  end
end

.should_document?(doc) ⇒ Boolean

Returns:

  • (Boolean) 


258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/jazzy/sourcekitten.rb', line 258

def self.should_document?(doc)
  return false if doc['key.doc.comment'].to_s.include?(':nodoc:')

  type = SourceDeclaration::Type.new(doc['key.kind'])

  # Always document Objective-C declarations.
  return true unless type.swift_type?

  # Don't document Swift types if we are hiding Swift
  return false if Config.instance.hide_swift?

  # Don't document @available declarations with no USR, since it means
  # they're unavailable.
  if availability_attribute?(doc) && !doc['key.usr']
    return false
  end

  # Only document @_spi declarations in some scenarios
  return false unless should_document_spi?(doc)

  # Don't document declarations excluded by the min_acl setting
  if type.swift_extension?
    should_document_swift_extension?(doc)
  else
    should_document_acl?(type, doc)
  end
end

.should_document_acl?(type, doc) ⇒ Boolean

Check visibility: access control

Returns:

  • (Boolean) 


297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/jazzy/sourcekitten.rb', line 297

def self.should_document_acl?(type, doc)
  # Include all enum elements for now, can't tell their ACL.
  return true if type.swift_enum_element?

  acl_ok = SourceDeclaration::AccessControlLevel.from_doc(doc) >= @min_acl
  unless acl_ok
    @stats.add_acl_skipped
    @inaccessible_protocols.append(doc['key.name']) if type.swift_protocol?
  end
  acl_ok
end

.should_document_spi?(doc) ⇒ Boolean

Check visibility: SPI

Returns:

  • (Boolean) 


287
288
289
290
291
292
293
294
 
# File 'lib/jazzy/sourcekitten.rb', line 287

def self.should_document_spi?(doc)
  spi_ok = @min_acl < SourceDeclaration::AccessControlLevel.public ||
           Config.instance.include_spi_declarations ||
           (!spi_attribute?(doc) && !doc['key.symgraph_spi'])

  @stats.add_spi_skipped unless spi_ok
  spi_ok
end

.should_document_swift_extension?(doc) ⇒ Boolean

Document extensions if they add protocol conformances, or have any member that needs to be documented.

Returns:

  • (Boolean) 


311
312
313
314
315
316
317
 
# File 'lib/jazzy/sourcekitten.rb', line 311

def self.should_document_swift_extension?(doc)
  doc['key.inheritedtypes'] ||
    Array(doc['key.substructure']).any? do |subdoc|
      subtype = SourceDeclaration::Type.new(subdoc['key.kind'])
      !subtype.mark? && should_document?(subdoc)
    end
end

.spi_attribute?(doc) ⇒ Boolean

Returns:

  • (Boolean) 


254
255
256
 
# File 'lib/jazzy/sourcekitten.rb', line 254

def self.spi_attribute?(doc)
  attribute?(doc, '_spi')
end

.split_decl_attributes(declaration) ⇒ Object

Split leading attributes from a decl, returning both parts.



429
430
431
432
 
# File 'lib/jazzy/sourcekitten.rb', line 429

def self.split_decl_attributes(declaration)
  declaration =~ /^((?:#{attribute_regexp('\w+')}\s*)*)(.*)$/m
  Regexp.last_match.captures
end

.subdir_for_doc(doc) ⇒ Object

Determine the subdirectory in which a doc should be placed. Guides in the root for back-compatibility. Declarations under outer namespace type (Structures, Classes, etc.)



119
120
121
122
123
124
125
126
 
# File 'lib/jazzy/sourcekitten.rb', line 119

def self.subdir_for_doc(doc)
  if Config.instance.multiple_modules?
    subdir_for_doc_multi_module(doc)
  else
    # Back-compatibility layout version
    subdir_for_doc_single_module(doc)
  end
end

.subdir_for_doc_multi_module(doc) ⇒ Object

Multi-module site layout, separate each module that is being documented.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/jazzy/sourcekitten.rb', line 140

def self.subdir_for_doc_multi_module(doc)
  # Guides + Groups in the root
  return [] if doc.type.markdown? || doc.type.overview?

  root_decl = doc.namespace_path.first

  # Extensions need an extra dir to allow for extending
  # ExternalModule1.TypeName and ExternalModule2.TypeName
  namespace_subdir =
    if root_decl.type.swift_extension?
      ['Extensions', root_decl.module_name]
    else
      [doc.namespace_path.first.type.plural_url_name]
    end

  [root_decl.doc_module_name] +
    namespace_subdir +
    doc.namespace_ancestors.map(&:name)
end

.subdir_for_doc_single_module(doc) ⇒ Object

Pre-multi-module site layout, does not allow for types with the same name.



130
131
132
133
134
135
136
 
# File 'lib/jazzy/sourcekitten.rb', line 130

def self.subdir_for_doc_single_module(doc)
  # Guides + Groups in the root
  return [] if doc.type.markdown? || doc.type.overview?

  [doc.namespace_path.first.type.plural_url_name] +
    doc.namespace_ancestors.map(&:name)
end

.swift_async?(fully_annotated_decl) ⇒ Boolean

Exclude non-async routines that accept async closures

Returns:

  • (Boolean) 


493
494
495
496
497
498
 
# File 'lib/jazzy/sourcekitten.rb', line 493

def self.swift_async?(fully_annotated_decl)
  document = REXML::Document.new(fully_annotated_decl)
  !document.elements['/*/syntaxtype.keyword[text()="async"]'].nil?
rescue StandardError
  nil
end

.undocumented_abstract ⇒ Object 



59
60
61
62
63
 
# File 'lib/jazzy/sourcekitten.rb', line 59

def self.undocumented_abstract
  @undocumented_abstract ||= Markdown.render(
    Config.instance.undocumented_text,
  ).freeze
end

.use_spm?(module_config) ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
176
177
178
179
 
# File 'lib/jazzy/sourcekitten.rb', line 173

def self.use_spm?(module_config)
  module_config.swift_build_tool == :spm ||
    (!module_config.swift_build_tool_configured &&
     Dir['*.xcodeproj', '*.xcworkspace'].empty? &&
     !module_config.build_tool_arguments.include?('-project') &&
     !module_config.build_tool_arguments.include?('-workspace'))
end

.xml_to_text(xml) ⇒ Object

Strip tags and convert entities



390
391
392
393
394
395
 
# File 'lib/jazzy/sourcekitten.rb', line 390

def self.xml_to_text(xml)
  document = REXML::Document.new(xml)
  REXML::XPath.match(document.root, '//text()').map(&:value).join
rescue StandardError
  ''
end