jazzy 0.8.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 521ac7a49708dd60f61fd8a5be45a0cabeadab01
-  data.tar.gz: d92a5318703bcdc5b70a30b02147c1b6318a5207
+  metadata.gz: 4d4de6485c397bd0feb5b8e6612644d5d9ab1e65
+  data.tar.gz: c5a15531eda99f16aa99db7b5f7d19159de53d8c
 SHA512:
-  metadata.gz: 4fbcffeba3be993af19ca581792fc18c2cef463df918ab0f0f7f5f76b04a09494d7dd7066c1b4a3a3125102178660cc4278f985d2becf2c9974eb32340c14004
-  data.tar.gz: 54f4db86a1b320ec74f98992c26757a4dc5fdd25e350942678d51bc0b15ab6910e6b0d2e3a8f5bd2d2f2eb172244039233ecbdf255c5bfecf0e1bd0ba6aa64f7
+  metadata.gz: 4a7ff1e6c421c32e8fd4ab654fa345f526bc9e812911063f9930964f1a86bee904397193e73e9c4a84170c9b4a49a466f6f31f7b8720adb9821e0069d2cb51bb
+  data.tar.gz: c4091c6b736b1030eb9b2a445e1bd2d141cf67efed5142ea5ececc48256529662f443c6fc4b5d8526cac3a14d8d5d8ec84530cbc175ec706b7caba41af8ba795

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+## 0.9.0
+
+##### Breaking
+
+* Generate documentation coverage badge locally. Since this avoids the failable
+  HTTP request to shields.io previously used to obtain the badge, we've removed
+  the `--[no-]download-badge` flag and the corresponding `download_badge`
+  YAML configuration key.  
+  [Samuel Giddins](https://github.com/segiddins)
+
+##### Enhancements
+
+* None.
+
+##### Bug Fixes
+
+* Fixed issue that prevented Jazzy from running on case sensitive file systems.  
+  [Jeremy David Giesbrecht](https://github.com/SDGGiesbrecht)
+  [#891](https://github.com/realm/jazzy/issues/891)
+
+* Fixed issue preventing `--podspec` from working with `test_spec`s.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#894](https://github.com/realm/jazzy/issues/894)
+
+* Always display correct declaration for undocumented symbols.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#864](https://github.com/realm/jazzy/issues/864)
+
+* Trim common indentation in multiline declarations.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#836](https://github.com/realm/jazzy/issues/836)
+
 ## 0.8.4
 
 ##### Breaking

data/Gemfile

@@ -4,7 +4,7 @@ gemspec
 
 group :development do
   # Code style
-  gem 'rubocop'
+  gem 'rubocop', '0.49.0'
 
   # Tests
   gem 'bacon'
@@ -14,9 +14,9 @@ group :development do
   gem 'webmock'
 
   # Integration tests
-  gem 'diffy'
   gem 'clintegracon', '0.7.0'
-  
+  gem 'diffy'
+
   # Code Review
   gem 'danger'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.8.4)
+    jazzy (0.9.0)
       cocoapods (~> 1.0)
       mustache (~> 0.99)
       open4
@@ -15,16 +15,16 @@ GEM
   remote: https://rubygems.org/
   specs:
     CFPropertyList (2.3.5)
-    activesupport (4.2.9)
+    activesupport (4.2.10)
       i18n (~> 0.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.5.1)
-      public_suffix (~> 2.0, >= 2.0.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
     ast (2.3.0)
     bacon (1.2.0)
-    claide (1.0.1)
+    claide (1.0.2)
     claide-plugins (0.9.2)
       cork
       nap
@@ -32,10 +32,10 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.2.1)
+    cocoapods (1.3.1)
       activesupport (>= 4.0.2, < 5)
-      claide (>= 1.0.1, < 2.0)
-      cocoapods-core (= 1.2.1)
+      claide (>= 1.0.2, < 2.0)
+      cocoapods-core (= 1.3.1)
       cocoapods-deintegrate (>= 1.0.1, < 2.0)
       cocoapods-downloader (>= 1.1.3, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -50,9 +50,9 @@ GEM
       molinillo (~> 0.5.7)
       nap (~> 1.0)
       ruby-macho (~> 1.1)
-      xcodeproj (>= 1.4.4, < 2.0)
-    cocoapods-core (1.2.1)
-      activesupport (>= 4.0.2, < 5)
+      xcodeproj (>= 1.5.1, < 2.0)
+    cocoapods-core (1.3.1)
+      activesupport (>= 4.0.2, < 6)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
     cocoapods-deintegrate (1.0.1)
@@ -61,17 +61,18 @@ GEM
       nap
     cocoapods-search (1.0.0)
     cocoapods-stats (1.0.0)
-    cocoapods-trunk (1.2.0)
+    cocoapods-trunk (1.3.0)
       nap (>= 0.8, < 2.0)
-      netrc (= 0.7.8)
+      netrc (~> 0.11)
     cocoapods-try (1.1.0)
     colored (1.2)
     colored2 (3.1.2)
+    concurrent-ruby (1.0.5)
     cork (0.3.0)
       colored2 (~> 3.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    danger (5.2.2)
+    danger (5.5.3)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -80,11 +81,12 @@ GEM
       faraday-http-cache (~> 1.0)
       git (~> 1)
       kramdown (~> 1.5)
-      octokit (~> 4.2)
+      no_proxy_fix
+      octokit (~> 4.7)
       terminal-table (~> 1)
     diffy (3.2.0)
     escape (0.0.4)
-    faraday (0.12.1)
+    faraday (0.13.1)
       multipart-post (>= 1.2, < 3)
     faraday-http-cache (1.3.1)
       faraday (~> 0.8)
@@ -93,13 +95,14 @@ GEM
     fuzzy_match (2.0.4)
     gh_inspector (1.0.3)
     git (1.3.0)
-    hashdiff (0.3.4)
-    i18n (0.8.6)
-    kramdown (1.13.2)
+    hashdiff (0.3.7)
+    i18n (0.9.0)
+      concurrent-ruby (~> 1.0)
+    kramdown (1.15.0)
     liferaft (0.0.6)
     metaclass (0.0.4)
     minitest (5.10.3)
-    mocha (1.2.1)
+    mocha (1.3.0)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.3)
       mocha (>= 0.13.0)
@@ -108,16 +111,18 @@ GEM
     mustache (0.99.8)
     nanaimo (0.2.3)
     nap (1.1.0)
-    netrc (0.7.8)
+    netrc (0.11.0)
+    no_proxy_fix (0.1.2)
     octokit (4.7.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
+    parallel (1.12.0)
     parser (2.4.0.0)
       ast (~> 2.2)
     powerpack (0.1.1)
     prettybacon (0.0.2)
       bacon (~> 1.2)
-    public_suffix (2.0.5)
+    public_suffix (3.0.0)
     rainbow (2.2.2)
       rake
     rake (10.5.0)
@@ -126,16 +131,17 @@ GEM
       ffi (>= 0.5.0, < 2)
     redcarpet (3.4.0)
     rouge (1.11.1)
-    rubocop (0.48.1)
+    rubocop (0.49.0)
+      parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-macho (1.1.0)
-    ruby-progressbar (1.8.1)
+    ruby-progressbar (1.9.0)
     safe_yaml (1.0.4)
-    sass (3.5.1)
+    sass (3.5.3)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -147,18 +153,18 @@ GEM
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.3)
+    tzinfo (1.2.4)
       thread_safe (~> 0.1)
-    unicode-display_width (1.2.1)
-    webmock (3.0.1)
+    unicode-display_width (1.3.0)
+    webmock (3.1.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.4.4)
+    xcodeproj (1.5.3)
       CFPropertyList (~> 2.3.3)
-      claide (>= 1.0.1, < 2.0)
+      claide (>= 1.0.2, < 2.0)
       colored2 (~> 3.1)
       nanaimo (~> 0.2.3)
 
@@ -176,7 +182,7 @@ DEPENDENCIES
   mocha-on-bacon
   prettybacon
   rake (~> 10.3)
-  rubocop
+  rubocop (= 0.49.0)
   webmock
 
 BUNDLED WITH

data/lib/jazzy/config.rb

@@ -211,6 +211,8 @@ module Jazzy
 
     config_attr :podspec,
       command_line: '--podspec FILEPATH',
+      description: 'A CocoaPods Podspec that describes the Swift library to '\
+                   'document',
       parse: ->(ps) { PodspecDocumenter.create_podspec(Pathname(ps)) if ps },
       default: Dir['*.podspec{,.json}'].first
 
@@ -297,7 +299,7 @@ module Jazzy
                    'other assets for a custom theme.',
       default: 'apple',
       parse: ->(t) do
-        if t == 'apple' || t == 'fullwidth'
+        if %w[apple fullwidth].include?(t)
           Pathname(__FILE__).parent + 'themes' + t
         else
           expand_path(t)
@@ -326,11 +328,6 @@ module Jazzy
         raise '--assets-directory is deprecated: use --theme instead.'
       end
 
-    config_attr :download_badge,
-      command_line: '--[no-]download-badge',
-      description: 'Download documentation coverage badge from shields.io.',
-      default: true
-
     # rubocop:enable Style/AlignParameters
 
     def initialize

data/lib/jazzy/doc_builder.rb

@@ -1,7 +1,5 @@
 require 'fileutils'
 require 'mustache'
-require 'uri'
-require 'net/http'
 require 'pathname'
 require 'sass'
 
@@ -131,7 +129,7 @@ module Jazzy
 
       DocsetBuilder.new(output_dir, source_module).build!
 
-      download_badge(source_module.doc_coverage, options)
+      generate_badge(source_module.doc_coverage, options)
 
       friendly_path = relative_path_if_inside(output_dir, Pathname.pwd)
       puts "jam out ♪♫ to your fresh new docs in `#{friendly_path}`"
@@ -244,38 +242,68 @@ module Jazzy
     # @param [Number] coverage The documentation coverage percentage
     def self.color_for_coverage(coverage)
       if coverage < 10
-        'red'
+        'e05d44' # red
       elsif coverage < 30
-        'orange'
+        'fe7d37' # orange
       elsif coverage < 60
-        'yellow'
+        'dfb317' # yellow
       elsif coverage < 85
-        'yellowgreen'
+        'a4a61d' # yellowgreen
       elsif coverage < 90
-        'green'
+        '97CA00' # green
       else
-        'brightgreen'
+        '4c1' # brightgreen
       end
     end
 
-    # Downloads an SVG from shields.io displaying the documentation percentage
+    # rubocop:disable Metrics/MethodLength
+
+    # Generates an SVG similar to those from shields.io displaying the
+    # documentation percentage
     # @param [Number] coverage The documentation coverage percentage
     # @param [Config] options Build options
-    def self.download_badge(coverage, options)
-      return if options.hide_documentation_coverage || !options.download_badge
+    def self.generate_badge(coverage, options)
+      return if options.hide_documentation_coverage
+
+      coverage_length = coverage.to_s.size.succ
+      percent_string_length = coverage_length * 80 + 10
+      percent_string_offset = coverage_length * 40 + 975
+      width = coverage_length * 8 + 104
+      svg = <<-SVG.gsub(/^ {8}/, '')
+        <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="#{width}" height="20">
+          <linearGradient id="b" x2="0" y2="100%">
+            <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+            <stop offset="1" stop-opacity=".1"/>
+          </linearGradient>
+          <clipPath id="a">
+            <rect width="#{width}" height="20" rx="3" fill="#fff"/>
+          </clipPath>
+          <g clip-path="url(#a)">
+            <path fill="#555" d="M0 0h93v20H0z"/>
+            <path fill="##{color_for_coverage(coverage)}" d="M93 0h#{percent_string_length / 10 + 10}v20H93z"/>
+            <path fill="url(#b)" d="M0 0h#{width}v20H0z"/>
+          </g>
+          <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110">
+            <text x="475" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="830">
+              documentation
+            </text>
+            <text x="475" y="140" transform="scale(.1)" textLength="830">
+              documentation
+            </text>
+            <text x="#{percent_string_offset}" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="#{percent_string_length}">
+              #{coverage}%
+            </text>
+            <text x="#{percent_string_offset}" y="140" transform="scale(.1)" textLength="#{percent_string_length}">
+              #{coverage}%
+            </text>
+          </g>
+        </svg>
+      SVG
 
-      warn 'downloading coverage badge'
-      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
+      File.open(badge_output, 'w') { |f| f << svg }
     end
+    # rubocop:enable Metrics/MethodLength
 
     def self.should_link_to_github(file)
       return unless file
@@ -307,7 +335,7 @@ module Jazzy
     def self.render_item(item, source_module)
       # Combine abstract and discussion into abstract
       abstract = (item.abstract || '') + (item.discussion || '')
-      item_render = {
+      {
         name:                       item.name,
         abstract:                   abstract,
         declaration:                item.declaration,
@@ -323,7 +351,6 @@ module Jazzy
         start_line:                 item.start_line,
         end_line:                   item.end_line,
       }
-      item_render.reject { |_, v| v.nil? }
     end
 
     def self.make_task(mark, uid, items)

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/podspec_documenter.rb

@@ -116,6 +116,9 @@ module Jazzy
                  deterministic_uuids: false
 
         [podspec, *podspec.recursive_subspecs].each do |ss|
+          # test_specification exists from CocoaPods 1.3.0
+          next if ss.respond_to?('test_specification') && ss.test_specification
+
           ss.available_platforms.each do |p|
             # Travis builds take too long when building docs for all available
             # platforms for the Moya integration spec, so we just document OSX.

data/lib/jazzy/sourcekitten.rb

@@ -2,7 +2,7 @@ require 'json'
 require 'pathname'
 require 'shellwords'
 require 'xcinvoke'
-require 'CGI'
+require 'cgi'
 
 require 'jazzy/config'
 require 'jazzy/executable'
@@ -306,10 +306,6 @@ module Jazzy
     def self.make_doc_info(doc, declaration)
       return unless should_document?(doc)
 
-      unless doc['key.doc.full_as_xml']
-        return process_undocumented_token(doc, declaration)
-      end
-
       declaration.declaration = Highlighter.highlight(
         doc['key.parsed_declaration'] || doc['key.doc.declaration'],
         Config.instance.objc_mode ? 'objc' : 'swift',
@@ -320,6 +316,10 @@ module Jazzy
         )
       end
 
+      unless doc['key.doc.full_as_xml']
+        return process_undocumented_token(doc, declaration)
+      end
+
       declaration.abstract = Markdown.render(doc['key.doc.comment'] || '')
       declaration.discussion = ''
       declaration.return = Markdown.rendered_returns
@@ -472,7 +472,7 @@ module Jazzy
         warn 'Found conflicting type declarations with the same name, which ' \
           'may indicate a build issue or a bug in Jazzy: ' +
              typedecls.map { |t| "#{t.type.name.downcase} #{t.name}" }
-             .join(', ')
+                      .join(', ')
       end
       typedecl = typedecls.first
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.0
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-28 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods