jazzy 0.13.7 → 0.14.0

data/lib/jazzy/stats.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 module Jazzy
   # Collect + report metadata about a processed module
   class Stats
     include Config::Mixin
 
-    attr_reader :documented, :acl_skipped
-    attr_reader :undocumented_decls
+    attr_reader :documented, :acl_skipped, :undocumented_decls
 
     def add_documented
       @documented += 1
@@ -57,6 +58,7 @@ module Jazzy
 
     def doc_coverage
       return 0 if acl_included == 0
+
       (100 * documented) / acl_included
     end
 

data/lib/jazzy/symbol_graph.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 require 'jazzy/symbol_graph/graph'
 require 'jazzy/symbol_graph/constraint'
@@ -37,7 +39,6 @@ module Jazzy
     end
 
     # Figure out the args to pass to symbolgraph-extract
-    # rubocop:disable Metrics/CyclomaticComplexity
     def self.arguments(config, output_path)
       if config.module_name.empty?
         raise 'error: `--swift-build-tool symbolgraph` requires `--module`.'
@@ -45,29 +46,28 @@ module Jazzy
 
       user_args = config.build_tool_arguments.join
 
-      if user_args =~ /--(?:module-name|minimum-access-level|output-dir)/
+      if user_args =~ /-(?:module-name|minimum-access-level|output-dir)/
         raise 'error: `--build-tool-arguments` for '\
-          "`--swift-build-tool symbolgraph` can't use `--module`, "\
-          '`--minimum-access-level`, or `--output-dir`.'
+          "`--swift-build-tool symbolgraph` can't use `-module`, "\
+          '`-minimum-access-level`, or `-output-dir`.'
       end
 
       # Default set
       args = [
-        "--module-name=#{config.module_name}",
-        '--minimum-access-level=private',
-        "--output-dir=#{output_path}",
-        '--skip-synthesized-members',
+        '-module-name', config.module_name,
+        '-minimum-access-level', 'private',
+        '-output-dir', output_path,
+        '-skip-synthesized-members'
       ]
 
       # Things user can override
-      args.append("--sdk=#{sdk(config)}") unless user_args =~ /--sdk/
-      args.append("--target=#{target}") unless user_args =~ /--target/
-      args.append("-F=#{config.source_directory}") unless user_args =~ /-F(?!s)/
-      args.append("-I=#{config.source_directory}") unless user_args =~ /-I/
+      args += ['-sdk', sdk(config)] unless user_args =~ /-sdk/
+      args += ['-target', target] unless user_args =~ /-target/
+      args += ['-F', config.source_directory.to_s] unless user_args =~ /-F(?!s)/
+      args += ['-I', config.source_directory.to_s] unless user_args =~ /-I/
 
       args + config.build_tool_arguments
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     # Get the SDK path.  On !darwin this just isn't needed.
     def self.sdk(config)
@@ -87,8 +87,8 @@ module Jazzy
     def self.demangle(usr)
       args = %w[demangle -simplified -compact].append(usr.sub(/^s:/, 's'))
       output, = Executable.execute_command('swift', args, true)
-      return output.chomp
-    rescue
+      output.chomp
+    rescue StandardError
       usr
     end
   end

data/lib/jazzy/symbol_graph/constraint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jazzy
   module SymbolGraph
     # Constraint is a tidied-up JSON object, used by both Symbol and
@@ -27,6 +29,7 @@ module Jazzy
       def self.new_hash(hash)
         kind = KIND_MAP[hash[:kind]]
         raise "Unknown constraint kind '#{kind}'" unless kind
+
         lhs = hash[:lhs].sub(/^Self\./, '')
         rhs = hash[:rhs].sub(/^Self\./, '')
         new(kind, lhs, rhs)
@@ -62,6 +65,7 @@ module Jazzy
              path_components.include?(hash[:rhs])
             next nil
           end
+
           Constraint.new_hash(hash)
         end.compact
       end
@@ -89,6 +93,6 @@ end
 
 class Array
   def to_where_clause
-    empty? ? '' : ' where ' + map(&:to_swift).join(', ')
+    empty? ? '' : " where #{map(&:to_swift).join(', ')}"
   end
 end

data/lib/jazzy/symbol_graph/ext_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jazzy
   module SymbolGraph
     # For extensions we need to track constraints of the extended type
@@ -68,7 +70,7 @@ module Jazzy
       def full_declaration
         decl = "extension #{name}"
         unless conformances.empty?
-          decl += ' : ' + conformances.join(', ')
+          decl += " : #{conformances.join(', ')}"
         end
         decl + all_constraints.ext.to_where_clause
       end

data/lib/jazzy/symbol_graph/graph.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # rubocop:disable Metrics/ClassLength
 module Jazzy
   module SymbolGraph
@@ -63,14 +65,14 @@ module Jazzy
       # Increasingly desparate ways to find the name of the symbol
       # at the target end of a relationship
       def rel_target_name(rel, target_node)
-        (target_node && target_node.symbol.name) ||
+        target_node&.symbol&.name ||
           rel.target_fallback ||
           Jazzy::SymbolGraph.demangle(rel.target_usr)
       end
 
       # Same for the source end.  Less help from the tool here
       def rel_source_name(rel, source_node)
-        (source_node && source_node.qualified_name) ||
+        source_node&.qualified_name ||
           Jazzy::SymbolGraph.demangle(rel.source_usr)
       end
 
@@ -86,11 +88,11 @@ module Jazzy
 
         source.protocol_requirement = rel.protocol_requirement?
         constraints =
-          ExtConstraints.new(target && target.constraints,
+          ExtConstraints.new(target&.constraints,
                              source.unique_context_constraints(target))
 
         # Add to its parent or invent an extension
-        unless target && target.try_add_child(source, constraints.ext)
+        unless target&.try_add_child(source, constraints.ext)
           add_ext_member(rel.target_usr, source, constraints)
         end
       end
@@ -101,7 +103,7 @@ module Jazzy
 
         return if redundant_conformance?(rel, source, protocol_name)
 
-        type_constraints = (source && source.constraints) || []
+        type_constraints = source&.constraints || []
         constraints =
           ExtConstraints.new(type_constraints,
                              rel.constraints - type_constraints)
@@ -122,7 +124,7 @@ module Jazzy
                target_parent.is_a?(SymNode)
           # Could probably figure this out with demangle, but...
           warn "Can't resolve membership of default implementation "\
-               "#{source.symbol.usr}."
+            "#{source.symbol.usr}."
           source.unlisted = true
           return
         end
@@ -174,14 +176,14 @@ module Jazzy
 
         root_symbol_nodes =
           symbol_nodes.values
-                      .select(&:top_level_decl?)
-                      .sort
-                      .map(&:to_sourcekit)
+            .select(&:top_level_decl?)
+            .sort
+            .map(&:to_sourcekit)
 
         root_ext_nodes =
           ext_nodes.values
-                   .sort
-                   .map { |n| n.to_sourcekit(module_name) }
+            .sort
+            .map { |n| n.to_sourcekit(module_name) }
         {
           'key.diagnostic_stage' => 'parse',
           'key.substructure' => root_symbol_nodes + root_ext_nodes,

data/lib/jazzy/symbol_graph/relationship.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jazzy
   module SymbolGraph
     # A Relationship is a tidied-up SymbolGraph JSON object
@@ -25,6 +27,7 @@ module Jazzy
         unless KINDS.include?(kind)
           raise "Unknown relationship kind '#{kind}'"
         end
+
         self.kind = kind.to_sym
         self.source_usr = hash[:source]
         self.target_usr = hash[:target]

data/lib/jazzy/symbol_graph/sym_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jazzy
   module SymbolGraph
     # The rebuilt syntax tree is made of nodes that either match
@@ -72,6 +74,7 @@ module Jazzy
                (!protocol? || node.protocol_requirement?)
           return false
         end
+
         add_child(node)
         true
       end
@@ -93,24 +96,26 @@ module Jazzy
       # conformance: don't bother if it's already in the type declaration.
       def conformance?(protocol)
         return false unless symbol.declaration =~ /(?<=:).*?(?=(where|$))/
+
         Regexp.last_match[0] =~ /\b#{protocol}\b/
       end
 
       # Generate the 'where' clause for the declaration
       def where_clause
-        parent_constraints = (parent && parent.constraints) || []
+        parent_constraints = parent&.constraints || []
         (constraints - parent_constraints).to_where_clause
       end
 
       def inherits_clause
         return '' unless superclass_name
+
         " : #{superclass_name}"
       end
 
       def full_declaration
         symbol.availability
-              .append(symbol.declaration + inherits_clause + where_clause)
-              .join("\n")
+          .append(symbol.declaration + inherits_clause + where_clause)
+          .join("\n")
       end
 
       # rubocop:disable Metrics/MethodLength
@@ -120,7 +125,7 @@ module Jazzy
 
         hash = {
           'key.kind' => symbol.kind,
-          'key.usr' =>  symbol.usr,
+          'key.usr' => symbol.usr,
           'key.name' => symbol.name,
           'key.accessibility' => symbol.acl,
           'key.parsed_decl' => declaration,
@@ -136,8 +141,8 @@ module Jazzy
         end
         if location = symbol.location
           hash['key.filepath'] = location[:filename]
-          hash['key.doc.line'] = location[:line]
-          hash['key.doc.column'] = location[:character]
+          hash['key.doc.line'] = location[:line] + 1
+          hash['key.doc.column'] = location[:character] + 1
         end
         unless children.empty?
           hash['key.substructure'] = children_to_sourcekit

data/lib/jazzy/symbol_graph/symbol.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # rubocop:disable Metrics/ClassLength
 module Jazzy
   module SymbolGraph
@@ -45,10 +47,10 @@ module Jazzy
       def init_declaration(raw_decl)
         # Too much 'Self.TypeName'; omitted arg labels look odd;
         # duplicated constraints; swift 5.3 vs. master workaround
-        self.declaration =
-          raw_decl.gsub(/\bSelf\./, '')
-                  .gsub(/(?<=\(|, )_: /, '_ arg: ')
-                  .gsub(/ where.*$/, '')
+        self.declaration = raw_decl
+          .gsub(/\bSelf\./, '')
+          .gsub(/(?<=\(|, )_: /, '_ arg: ')
+          .gsub(/ where.*$/, '')
         if kind == 'source.lang.swift.decl.class'
           declaration.sub!(/\s*:.*$/, '')
         end
@@ -90,6 +92,7 @@ module Jazzy
       # We treat 'static var' differently to 'class var'
       def adjust_kind_for_declaration(kind)
         return kind unless declaration =~ /\bstatic\b/
+
         kind.gsub(/type/, 'static')
       end
 
@@ -97,13 +100,14 @@ module Jazzy
         adjusted = adjust_kind_for_declaration(kind)
         sourcekit_kind = KIND_MAP[adjusted.sub('swift.', '')]
         raise "Unknown symbol kind '#{kind}'" unless sourcekit_kind
-        self.kind = 'source.lang.swift.decl.' + sourcekit_kind
+
+        self.kind = "source.lang.swift.decl.#{sourcekit_kind}"
       end
 
       # Mapping SymbolGraph's ACL to SourceKit
 
       def init_acl(acl)
-        self.acl = 'source.lang.swift.accessibility.' + acl
+        self.acl = "source.lang.swift.accessibility.#{acl}"
       end
 
       # Symbol location - only available for public+ decls
@@ -120,6 +124,7 @@ module Jazzy
       def init_constraints(hash, raw_decl)
         raw_constraints = %i[swiftGenerics swiftExtension].flat_map do |key|
           next [] unless container = hash[key]
+
           container[:constraints] || []
         end
 
@@ -146,9 +151,9 @@ module Jazzy
       end
 
       def init_doc_comments(comments_hash)
-        self.doc_comments =
-          comments_hash[:lines].map { |l| l[:text] }
-                               .join("\n")
+        self.doc_comments = comments_hash[:lines]
+          .map { |l| l[:text] }
+          .join("\n")
       end
 
       # Availability
@@ -171,8 +176,8 @@ module Jazzy
             next nil
           end
 
-          str += ', message: "' + avail[:message] + '"' if avail[:message]
-          str += ', renamed: "' + avail[:renamed] + '"' if avail[:renamed]
+          str += ", message: \"#{avail[:message]}\"" if avail[:message]
+          str += ", renamed: \"#{avail[:renamed]}\"" if avail[:renamed]
 
           str + ')'
         end.compact
@@ -188,8 +193,6 @@ module Jazzy
       # Sort order
       include Comparable
 
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/PerceivedComplexity
       def <=>(other)
         # Things with location: order by file/line/column
         # (pls tell what wheel i am reinventing :/)
@@ -198,6 +201,7 @@ module Jazzy
             if location[:line] == other_loc[:line]
               return location[:character] <=> other_loc[:character]
             end
+
             return location[:line] <=> other_loc[:line]
           end
           return location[:filename] <=> other_loc[:filename]
@@ -209,10 +213,9 @@ module Jazzy
 
         # Things without a location: by name and then USR
         return usr <=> other.usr if name == other.name
+
         name <=> other.name
       end
-      # rubocop:enable Metrics/PerceivedComplexity
-      # rubocop:enable Metrics/CyclomaticComplexity
     end
   end
 end

data/lib/jazzy/themes/apple/assets/css/highlight.css.scss

@@ -1,63 +1,67 @@
+/*! Jazzy - https://github.com/realm/jazzy
+ *  Copyright Realm Inc.
+ *  SPDX-License-Identifier: MIT
+ */
 /* Credit to https://gist.github.com/wataru420/2048287 */
 
 .highlight {
-  .c { color: #999988; font-style: italic } /* Comment */
-  .err { color: #a61717; background-color: #e3d2d2 } /* Error */
-  .k { color: #000000; font-weight: bold } /* Keyword */
-  .o { color: #000000; font-weight: bold } /* Operator */
-  .cm { color: #999988; font-style: italic } /* Comment.Multiline */
-  .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
-  .c1 { color: #999988; font-style: italic } /* Comment.Single */
-  .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
-  .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
-  .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
-  .ge { color: #000000; font-style: italic } /* Generic.Emph */
-  .gr { color: #aa0000 } /* Generic.Error */
-  .gh { color: #999999 } /* Generic.Heading */
-  .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
-  .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
-  .go { color: #888888 } /* Generic.Output */
-  .gp { color: #555555 } /* Generic.Prompt */
-  .gs { font-weight: bold } /* Generic.Strong */
-  .gu { color: #aaaaaa } /* Generic.Subheading */
-  .gt { color: #aa0000 } /* Generic.Traceback */
-  .kc { color: #000000; font-weight: bold } /* Keyword.Constant */
-  .kd { color: #000000; font-weight: bold } /* Keyword.Declaration */
-  .kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */
-  .kr { color: #000000; font-weight: bold } /* Keyword.Reserved */
-  .kt { color: #445588; } /* Keyword.Type */
-  .m { color: #009999 } /* Literal.Number */
-  .s { color: #d14 } /* Literal.String */
-  .na { color: #008080 } /* Name.Attribute */
-  .nb { color: #0086B3 } /* Name.Builtin */
-  .nc { color: #445588; font-weight: bold } /* Name.Class */
-  .no { color: #008080 } /* Name.Constant */
-  .ni { color: #800080 } /* Name.Entity */
-  .ne { color: #990000; font-weight: bold } /* Name.Exception */
-  .nf { color: #990000; } /* Name.Function */
-  .nn { color: #555555 } /* Name.Namespace */
-  .nt { color: #000080 } /* Name.Tag */
-  .nv { color: #008080 } /* Name.Variable */
-  .ow { color: #000000; font-weight: bold } /* Operator.Word */
-  .w { color: #bbbbbb } /* Text.Whitespace */
-  .mf { color: #009999 } /* Literal.Number.Float */
-  .mh { color: #009999 } /* Literal.Number.Hex */
-  .mi { color: #009999 } /* Literal.Number.Integer */
-  .mo { color: #009999 } /* Literal.Number.Oct */
-  .sb { color: #d14 } /* Literal.String.Backtick */
-  .sc { color: #d14 } /* Literal.String.Char */
-  .sd { color: #d14 } /* Literal.String.Doc */
-  .s2 { color: #d14 } /* Literal.String.Double */
-  .se { color: #d14 } /* Literal.String.Escape */
-  .sh { color: #d14 } /* Literal.String.Heredoc */
-  .si { color: #d14 } /* Literal.String.Interpol */
-  .sx { color: #d14 } /* Literal.String.Other */
-  .sr { color: #009926 } /* Literal.String.Regex */
-  .s1 { color: #d14 } /* Literal.String.Single */
-  .ss { color: #990073 } /* Literal.String.Symbol */
-  .bp { color: #999999 } /* Name.Builtin.Pseudo */
-  .vc { color: #008080 } /* Name.Variable.Class */
-  .vg { color: #008080 } /* Name.Variable.Global */
-  .vi { color: #008080 } /* Name.Variable.Instance */
-  .il { color: #009999 } /* Literal.Number.Integer.Long */
+  .c { color: #999988; font-style: italic } // Comment
+  .err { color: #a61717; background-color: #e3d2d2 } // Error
+  .k { color: #000000; font-weight: bold } // Keyword
+  .o { color: #000000; font-weight: bold } // Operator
+  .cm { color: #999988; font-style: italic } // Comment.Multiline
+  .cp { color: #999999; font-weight: bold } // Comment.Preproc
+  .c1 { color: #999988; font-style: italic } // Comment.Single
+  .cs { color: #999999; font-weight: bold; font-style: italic } // Comment.Special
+  .gd { color: #000000; background-color: #ffdddd } // Generic.Deleted
+  .gd .x { color: #000000; background-color: #ffaaaa } // Generic.Deleted.Specific
+  .ge { color: #000000; font-style: italic } // Generic.Emph
+  .gr { color: #aa0000 } // Generic.Error
+  .gh { color: #999999 } // Generic.Heading
+  .gi { color: #000000; background-color: #ddffdd } // Generic.Inserted
+  .gi .x { color: #000000; background-color: #aaffaa } // Generic.Inserted.Specific
+  .go { color: #888888 } // Generic.Output
+  .gp { color: #555555 } // Generic.Prompt
+  .gs { font-weight: bold } // Generic.Strong
+  .gu { color: #aaaaaa } // Generic.Subheading
+  .gt { color: #aa0000 } // Generic.Traceback
+  .kc { color: #000000; font-weight: bold } // Keyword.Constant
+  .kd { color: #000000; font-weight: bold } // Keyword.Declaration
+  .kp { color: #000000; font-weight: bold } // Keyword.Pseudo
+  .kr { color: #000000; font-weight: bold } // Keyword.Reserved
+  .kt { color: #445588; } // Keyword.Type
+  .m { color: #009999 } // Literal.Number
+  .s { color: #d14 } // Literal.String
+  .na { color: #008080 } // Name.Attribute
+  .nb { color: #0086B3 } // Name.Builtin
+  .nc { color: #445588; font-weight: bold } // Name.Class
+  .no { color: #008080 } // Name.Constant
+  .ni { color: #800080 } // Name.Entity
+  .ne { color: #990000; font-weight: bold } // Name.Exception
+  .nf { color: #990000; } // Name.Function
+  .nn { color: #555555 } // Name.Namespace
+  .nt { color: #000080 } // Name.Tag
+  .nv { color: #008080 } // Name.Variable
+  .ow { color: #000000; font-weight: bold } // Operator.Word
+  .w { color: #bbbbbb } // Text.Whitespace
+  .mf { color: #009999 } // Literal.Number.Float
+  .mh { color: #009999 } // Literal.Number.Hex
+  .mi { color: #009999 } // Literal.Number.Integer
+  .mo { color: #009999 } // Literal.Number.Oct
+  .sb { color: #d14 } // Literal.String.Backtick
+  .sc { color: #d14 } // Literal.String.Char
+  .sd { color: #d14 } // Literal.String.Doc
+  .s2 { color: #d14 } // Literal.String.Double
+  .se { color: #d14 } // Literal.String.Escape
+  .sh { color: #d14 } // Literal.String.Heredoc
+  .si { color: #d14 } // Literal.String.Interpol
+  .sx { color: #d14 } // Literal.String.Other
+  .sr { color: #009926 } // Literal.String.Regex
+  .s1 { color: #d14 } // Literal.String.Single
+  .ss { color: #990073 } // Literal.String.Symbol
+  .bp { color: #999999 } // Name.Builtin.Pseudo
+  .vc { color: #008080 } // Name.Variable.Class
+  .vg { color: #008080 } // Name.Variable.Global
+  .vi { color: #008080 } // Name.Variable.Instance
+  .il { color: #009999 } // Literal.Number.Integer.Long
 }