jazzy 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b7c32e3e4852444ab51ebfb2769dfd60a798e51
-  data.tar.gz: 79448b6ccf52510142b1612f279eb5bc46619b1d
+  metadata.gz: 9b6c8d617080bf1a2a5d1930f3c63c630da8869e
+  data.tar.gz: 558a557588f533343725d3efc06cf7c00d25e241
 SHA512:
-  metadata.gz: 4bf01a81ca089fa588c0f2a9630fc61384b17199d634930b0764e6b22d6b45135bb288661e9ae89e914a24c66e4fa9db11058f3b74993b3e436b9525b86f2800
-  data.tar.gz: 35fa4a004b97fce136135b53eeb13dc35cf6ebb40c27e12c6077badfc898bfe57526d65ea389299888ba040f0c2bc82031ab62fd3790bdcf85fec2e8909053c7
+  metadata.gz: 22f290f2559756550a4122c9338528d6d0b9a21a66f5d4f2906e1f35d0c8f7f20d3ecc2285a88a900619d5d17170fb70548ed971de1bde3d08045b5ab026392d
+  data.tar.gz: 87ac65fd0994caf9229c76d6c68e837b0fa167863d213a33834be1c16f6d8212703fcce5ca2d8219a9573407432447aaf9597beead518877b67235c6b5a3d1ad

data/.rubocop.yml

@@ -31,6 +31,9 @@ Metrics/BlockLength:
 Style/NumericPredicate:
   Enabled: false
 
+Style/IndentHeredoc:
+  Enabled: false
+
 # We adopted raise instead of fail.
 SignalException:
   EnforcedStyle: only_raise

data/CHANGELOG.md

@@ -1,3 +1,42 @@
+## 0.8.3
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Generate Swift declaration for more Objective-C declarations.  
+  [Zheng Li](https://github.com/ainopara)
+
+* Improve quality & accuracy of Swift interfaces for Objective-C declarations
+  when generating Objective-C docs.  
+  [Norio Nomura](https://github.com/norio-nomura)
+
+* Process Swift 3.2/4 doc comments.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+##### Bug Fixes
+
+* Fix missing doc comments on some extensions.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#454](https://github.com/realm/jazzy/issues/454)
+
+* Fix failure when attempting to download documentation coverage badge with
+  jazzy using macOS system Ruby, or a Ruby built with outdated versions of
+  OpenSSL.  
+  [JP Simard](https://github.com/jpsim)
+  [#824](https://github.com/realm/jazzy/issues/824)
+
+* Stop `--skip-undocumented` from skipping documented items nested
+  inside extensions of types from other modules.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#502](https://github.com/realm/jazzy/issues/502)
+
+* Fix members added to extensions of a nested type showing up in the parent.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#333](https://github.com/realm/jazzy/issues/333)
+
 ## 0.8.2
 
 ##### Breaking

data/Gemfile

@@ -15,7 +15,7 @@ group :development do
 
   # Integration tests
   gem 'diffy'
-  gem 'clintegracon'
+  gem 'clintegracon', '0.7.0'
   
   # Code Review
   gem 'danger'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.8.2)
+    jazzy (0.8.3)
       cocoapods (~> 1.0)
       mustache (~> 0.99)
       open4
@@ -20,7 +20,7 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.5.0)
+    addressable (2.5.1)
       public_suffix (~> 2.0, >= 2.0.2)
     ast (2.3.0)
     bacon (1.2.0)
@@ -67,14 +67,14 @@ GEM
     cocoapods-try (1.1.0)
     colored (1.2)
     colored2 (3.1.2)
-    cork (0.2.0)
-      colored (~> 1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    danger (4.0.1)
+    danger (5.2.2)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
-      colored (~> 1.2)
+      colored2 (~> 3.1)
       cork (~> 0.1)
       faraday (~> 0.9)
       faraday-http-cache (~> 1.0)
@@ -82,9 +82,9 @@ GEM
       kramdown (~> 1.5)
       octokit (~> 4.2)
       terminal-table (~> 1)
-    diffy (3.1.0)
+    diffy (3.2.0)
     escape (0.0.4)
-    faraday (0.10.0)
+    faraday (0.12.1)
       multipart-post (>= 1.2, < 3)
     faraday-http-cache (1.3.1)
       faraday (~> 0.8)
@@ -92,15 +92,15 @@ GEM
     fuzzy_match (2.0.4)
     gh_inspector (1.0.3)
     git (1.3.0)
-    hashdiff (0.3.0)
+    hashdiff (0.3.4)
     i18n (0.8.1)
-    kramdown (1.13.1)
+    kramdown (1.13.2)
     liferaft (0.0.6)
     metaclass (0.0.4)
-    minitest (5.10.1)
-    mocha (1.1.0)
+    minitest (5.10.2)
+    mocha (1.2.1)
       metaclass (~> 0.0.1)
-    mocha-on-bacon (0.2.2)
+    mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
     molinillo (0.5.7)
     multipart-post (2.0.0)
@@ -108,20 +108,21 @@ GEM
     nanaimo (0.2.3)
     nap (1.1.0)
     netrc (0.7.8)
-    octokit (4.6.2)
+    octokit (4.7.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parser (2.3.3.1)
+    parser (2.4.0.0)
       ast (~> 2.2)
     powerpack (0.1.1)
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    public_suffix (2.0.4)
-    rainbow (2.2.1)
+    public_suffix (2.0.5)
+    rainbow (2.2.2)
+      rake
     rake (10.5.0)
     redcarpet (3.4.0)
     rouge (1.11.1)
-    rubocop (0.47.1)
+    rubocop (0.48.1)
       parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
@@ -130,17 +131,18 @@ GEM
     ruby-macho (1.1.0)
     ruby-progressbar (1.8.1)
     safe_yaml (1.0.4)
-    sass (3.4.23)
+    sass (3.4.24)
     sawyer (0.8.1)
       addressable (>= 2.3.5, < 2.6)
       faraday (~> 0.8, < 1.0)
     sqlite3 (1.3.13)
-    terminal-table (1.6.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
-    unicode-display_width (1.1.3)
-    webmock (1.24.2)
+    unicode-display_width (1.2.1)
+    webmock (3.0.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -158,7 +160,7 @@ PLATFORMS
 DEPENDENCIES
   bacon
   bundler (~> 1.7)
-  clintegracon
+  clintegracon (= 0.7.0)
   danger
   diffy
   jazzy!

data/README.md

@@ -86,7 +86,7 @@ parameters to jazzy:
 
 * `--objc`
 * `--umbrella-header ...`
-* `-framework-root ...`
+* `--framework-root ...`
 * `--sdk [iphone|watch|appletv][os|simulator]|macosx` (optional, default value
    of `macosx`)
 

data/Rakefile

@@ -71,8 +71,10 @@ begin
 
   #-- RuboCop ----------------------------------------------------------------#
 
-  require 'rubocop/rake_task'
-  RuboCop::RakeTask.new(:rubocop)
+  desc 'Runs RuboCop linter on Ruby files'
+  task :rubocop do
+    sh 'bundle exec rubocop lib spec'
+  end
 
   #-- SourceKitten -----------------------------------------------------------#
 

data/lib/jazzy/config.rb

@@ -402,7 +402,7 @@ module Jazzy
       puts "Using config file #{config_path}"
       config_file = read_config_file(config_path)
 
-      attrs_by_conf_key, attrs_by_name = %i(config_file_key name).map do |prop|
+      attrs_by_conf_key, attrs_by_name = %i[config_file_key name].map do |prop|
         self.class.all_config_attrs.group_by(&prop)
       end
 

data/lib/jazzy/doc_builder.rb

@@ -39,7 +39,7 @@ module Jazzy
           # FIXME: include arbitrarily nested extensible types
           [{ name: child.name, url: child.url }] +
             Array(child.children.select do |sub_child|
-              sub_child.type.swift_extensible?
+              sub_child.type.swift_extensible? || sub_child.type.extension?
             end).map do |sub_child|
               { name: "– #{sub_child.name}", url: sub_child.url }
             end
@@ -259,14 +259,15 @@ module Jazzy
       return if options.hide_documentation_coverage || !options.download_badge
 
       warn 'downloading coverage badge'
-      color = color_for_coverage(coverage)
-      uri = URI.parse('https://img.shields.io')
-      url_path = "/badge/documentation-#{coverage}%25-#{color}.svg"
-      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        resp = http.get url_path
-        File.open(options.output + 'badge.svg', 'wb') do |file|
-          file.write resp.body
-        end
+      badge_url = 'https://img.shields.io/badge/documentation-' \
+        "#{coverage}%25-#{color_for_coverage(coverage)}.svg"
+      badge_output = options.output + 'badge.svg'
+      system('curl', '-s', badge_url, '-o', badge_output.to_s)
+      unless $?.success?
+        warn 'Downloading documentation coverage badge failed.'
+        warn 'Please try again when connected to the Internet, or skip the ' \
+             'download by passing the `--no-download-badge` command flag.'
+        exit $?.exitstatus || 1
       end
     end
 

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/jazzy_markdown.rb

@@ -21,10 +21,10 @@ module Jazzy
 
       # List from
       # https://github.com/apple/swift/blob/master/include/swift/Markup/SimpleFields.def
-      UNIQUELY_HANDLED_CALLOUTS = %w(parameters
+      UNIQUELY_HANDLED_CALLOUTS = %w[parameters
                                      parameter
-                                     returns).freeze
-      GENERAL_CALLOUTS = %w(attention
+                                     returns].freeze
+      GENERAL_CALLOUTS = %w[attention
                             author
                             authors
                             bug
@@ -51,7 +51,7 @@ module Jazzy
                             todo
                             throws
                             version
-                            warning).freeze
+                            warning].freeze
       SPECIAL_LIST_TYPES = (UNIQUELY_HANDLED_CALLOUTS + GENERAL_CALLOUTS).freeze
 
       SPECIAL_LIST_TYPE_REGEX = %r{

data/lib/jazzy/podspec_documenter.rb

@@ -24,7 +24,7 @@ module Jazzy
                              .map(&:label)
 
           targets.map do |t|
-            args = %W(doc --module-name #{podspec.module_name} -- -target #{t})
+            args = %W[doc --module-name #{podspec.module_name} -- -target #{t}]
             swift_version = (config.swift_version || '3')[0] + '.0'
             args << "SWIFT_VERSION=\"#{swift_version}\""
             SourceKitten.run_sourcekitten(args)

data/lib/jazzy/readme_generator.rb

@@ -18,7 +18,7 @@ module Jazzy
 
     def self.readme_path
       return config.readme_path if config.readme_path
-      %w(README.md README.markdown README.mdown README).each do |potential_name|
+      %w[README.md README.markdown README.mdown README].each do |potential_name|
         file = config.source_directory + potential_name
         return file if file.exist?
       end

data/lib/jazzy/source_document.rb

@@ -38,7 +38,7 @@ module Jazzy
     end
 
     def fallback_readme
-      %w(README.md README.markdown README.mdown README).each do |potential_name|
+      %w[README.md README.markdown README.mdown README].each do |potential_name|
         file = config.source_directory + potential_name
         return file.read if file.exist?
       end

data/lib/jazzy/source_module.rb

@@ -37,7 +37,7 @@ module Jazzy
         d.map(&:children).each { |c| visitor[c] }
       end
       visitor[docs]
-      all_declarations.select { |doc| doc.name != 'index' }
+      all_declarations.reject { |doc| doc.name == 'index' }
     end
   end
 end

data/lib/jazzy/sourcekitten.rb

@@ -47,7 +47,7 @@ end
 module Jazzy
   # This module interacts with the sourcekitten command-line executable
   module SourceKitten
-    @default_abstract = Markdown.render('Undocumented').freeze
+    @undocumented_abstract = Markdown.render('Undocumented').freeze
 
     # Group root-level docs by custom categories (if any) and type
     def self.group_docs(docs)
@@ -222,16 +222,11 @@ module Jazzy
       # @todo: Fix these
       declaration.line = nil
       declaration.column = nil
-      declaration.abstract = @default_abstract
+      declaration.abstract = ''
       declaration.parameters = []
       declaration.children = []
     end
 
-    def self.documented_child?(doc)
-      return false unless doc['key.substructure']
-      doc['key.substructure'].any? { |child| documented_child?(child) }
-    end
-
     def self.availability_attribute?(doc)
       return false unless doc['key.attributes']
       !doc['key.attributes'].select do |attribute|
@@ -276,13 +271,20 @@ module Jazzy
     end
 
     def self.process_undocumented_token(doc, declaration)
+      make_default_doc_info(declaration)
+
       filepath = doc['key.filepath']
       objc = Config.instance.objc_mode
       if objc || should_mark_undocumented(doc['key.kind'], filepath)
         @stats.add_undocumented(declaration)
+        return nil if @skip_undocumented
+        declaration.abstract = @undocumented_abstract
+      else
+        comment = doc['key.doc.comment']
+        declaration.abstract = Markdown.render(comment) if comment
       end
-      return nil if !documented_child?(doc) && @skip_undocumented
-      make_default_doc_info(declaration)
+
+      declaration
     end
 
     def self.parameters(doc, discovered)
@@ -382,6 +384,7 @@ module Jazzy
 
         next unless make_doc_info(doc, declaration)
         make_substructure(doc, declaration)
+        next if declaration.type.extension? && declaration.children.empty?
         declarations << declaration
       end
       declarations
@@ -390,6 +393,36 @@ module Jazzy
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/MethodLength
 
+    # Expands extensions of nested types declared at the top level into
+    # a tree so they can be deduplicated properly
+    def self.expand_extensions(decls)
+      decls.map do |decl|
+        next decl unless decl.type.extension? && decl.name.include?('.')
+
+        name_parts = decl.name.split('.')
+        decl.name = name_parts.pop
+        expand_extension(decl, name_parts, decls)
+      end
+    end
+
+    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.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
+
     # Merges multiple extensions of the same entity into a single document.
     #
     # Merges extensions into the protocol/class/struct/enum they extend, if it
@@ -612,6 +645,7 @@ module Jazzy
       @stats = Stats.new
       sourcekitten_json = filter_excluded_files(JSON.parse(sourcekitten_output))
       docs = make_source_declarations(sourcekitten_json).concat inject_docs
+      docs = expand_extensions(docs)
       docs = deduplicate_declarations(docs)
       if Config.instance.objc_mode
         docs = reject_objc_types(docs)

data/spec/integration_spec.rb

@@ -53,7 +53,7 @@ Pod::Config.instance.with_changes(silent: true) do
   config = Pod::Config.instance
   # working around a bug where `pod setup --silent` isn't silent
   if config.sources_manager.master_repo_functional?
-    Pod::Command::Repo::Update.invoke(%w(master))
+    Pod::Command::Repo::Update.invoke(%w[master])
   else
     Pod::Command::Setup.invoke
   end
@@ -104,6 +104,9 @@ describe_cli 'jazzy' do
     s.default_args = []
     s.replace_path ROOT.to_s, 'ROOT'
     s.replace_pattern /^[\d\s:.-]+ ruby\[\d+:\d+\] warning:.*$[\n]?/, ''
+    # Remove version numbers from CocoaPods dependencies
+    # to make specs resilient against dependecy updates.
+    s.replace_pattern /(Installing \w+ )\((.*)\)/, '\1(X.Y.Z)'
   end
 
   require 'shellwords'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-13 00:00:00.000000000 Z
+date: 2017-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods