jazzy 0.7.5 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9754b8ad015ab378ddfb5ab40c230511104d3bc
-  data.tar.gz: 3f0c52c2516d07f1bf88836b61ef2f820ff715fc
+  metadata.gz: dc460519a4f57d266ecc60cbc931be6206c3d619
+  data.tar.gz: ee27a31724d4c8740edf0060ea1f0395a75c34cd
 SHA512:
-  metadata.gz: 84f40dafc121c96a64eb76a6054a6da077aef3156eca4e9519c31556d98311408e19c5cb39c23bae5328f017e942f28d468a90e19a38eb602275f4e9c63242ff
-  data.tar.gz: a03ffdcbb9c68338019cbb784cd9ad6c8cc971a48e05c58f889b460b7961974058e71600eb12a23595c76e0d366acad6fd4b3bc965010f3f3264677d04aa1e96
+  metadata.gz: 72ae7b9ea2eebf2dd6d7a487453cb81e33bbcebece34c63c94fe61117dda83853acbb05d74d346c331026fb0362487cf874d4fbc98d896840b4f7e84b8b26957
+  data.tar.gz: 9a6a51fe79fa42185ae16375f0560c9e471c07e59dad504663db53ab9ee1d7b748e9971f7da5ddd3bba9b6365e1ca62925a36add31e1da3b89204e8b7c3a0df8

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+## 0.8.0
+
+##### Breaking
+
+* `undocumented.json` is now only in the output directory and is no longer
+  copied into docsets.  
+  [Jeremy David Giesbrecht](https://github.com/SDGGiesbrecht)
+  [#754](https://github.com/realm/jazzy/issues/754)
+
+##### Enhancements
+
+* Add `--[no-]download-badge` flag to skip downloading the documentation
+  coverage badge from shields.io. Useful if generating docs offline.  
+  [JP Simard](https://github.com/jpsim)
+  [#765](https://github.com/realm/jazzy/issues/765)
+
+##### Bug Fixes
+
+* Blank line no longer needed before lists or code blocks.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#546](https://github.com/realm/jazzy/issues/546)
+
+* Linking to headers in apple theme gives correct vertical alignment.  
+  [John Fairhurst](https://github.com/johnfairh)
+
+* Headers in source code markdown no longer cause corruption.  
+  [John Fairhurst](https://github.com/johnfairh)
+  [#628](https://github.com/realm/jazzy/issues/628)
+
 ## 0.7.5
 
 ##### Breaking

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.7.5)
+    jazzy (0.8.0)
       cocoapods (~> 1.0)
       mustache (~> 0.99)
       open4
@@ -15,9 +15,8 @@ GEM
   remote: https://rubygems.org/
   specs:
     CFPropertyList (2.3.5)
-    activesupport (4.2.7.1)
+    activesupport (4.2.8)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
@@ -33,26 +32,26 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.2.0)
+    cocoapods (1.2.1)
       activesupport (>= 4.0.2, < 5)
       claide (>= 1.0.1, < 2.0)
-      cocoapods-core (= 1.2.0)
+      cocoapods-core (= 1.2.1)
       cocoapods-deintegrate (>= 1.0.1, < 2.0)
       cocoapods-downloader (>= 1.1.3, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
       cocoapods-search (>= 1.0.0, < 2.0)
       cocoapods-stats (>= 1.0.0, < 2.0)
-      cocoapods-trunk (>= 1.1.2, < 2.0)
+      cocoapods-trunk (>= 1.2.0, < 2.0)
       cocoapods-try (>= 1.1.0, < 2.0)
-      colored (~> 1.2)
+      colored2 (~> 3.1)
       escape (~> 0.0.4)
       fourflusher (~> 2.0.1)
       gh_inspector (~> 1.0)
-      molinillo (~> 0.5.5)
+      molinillo (~> 0.5.7)
       nap (~> 1.0)
-      ruby-macho (~> 0.2.5)
-      xcodeproj (>= 1.4.1, < 2.0)
-    cocoapods-core (1.2.0)
+      ruby-macho (~> 1.1)
+      xcodeproj (>= 1.4.4, < 2.0)
+    cocoapods-core (1.2.1)
       activesupport (>= 4.0.2, < 5)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
@@ -62,11 +61,12 @@ GEM
       nap
     cocoapods-search (1.0.0)
     cocoapods-stats (1.0.0)
-    cocoapods-trunk (1.1.2)
+    cocoapods-trunk (1.2.0)
       nap (>= 0.8, < 2.0)
       netrc (= 0.7.8)
     cocoapods-try (1.1.0)
     colored (1.2)
+    colored2 (3.1.2)
     cork (0.2.0)
       colored (~> 1.2)
     crack (0.4.3)
@@ -93,8 +93,7 @@ GEM
     gh_inspector (1.0.3)
     git (1.3.0)
     hashdiff (0.3.0)
-    i18n (0.8.0)
-    json (1.8.6)
+    i18n (0.8.1)
     kramdown (1.13.1)
     liferaft (0.0.6)
     metaclass (0.0.4)
@@ -103,7 +102,7 @@ GEM
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.2)
       mocha (>= 0.13.0)
-    molinillo (0.5.6)
+    molinillo (0.5.7)
     multipart-post (2.0.0)
     mustache (0.99.8)
     nanaimo (0.2.3)
@@ -128,7 +127,7 @@ GEM
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-macho (0.2.6)
+    ruby-macho (1.1.0)
     ruby-progressbar (1.8.1)
     safe_yaml (1.0.4)
     sass (3.4.23)
@@ -137,8 +136,8 @@ GEM
       faraday (~> 0.8, < 1.0)
     sqlite3 (1.3.13)
     terminal-table (1.6.0)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
       thread_safe (~> 0.1)
     unicode-display_width (1.1.3)
     webmock (1.24.2)
@@ -147,11 +146,10 @@ GEM
       hashdiff
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.4.2)
+    xcodeproj (1.4.4)
       CFPropertyList (~> 2.3.3)
-      activesupport (>= 3)
       claide (>= 1.0.1, < 2.0)
-      colored (~> 1.2)
+      colored2 (~> 3.1)
       nanaimo (~> 0.2.3)
 
 PLATFORMS
@@ -172,4 +170,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.14.3
+   1.14.6

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Resources

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current/Resources

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/SourceKittenFramework

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current/SourceKittenFrame

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Commandant

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.f

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Resources

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.f

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/Current

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.f

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Resources

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.frame

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Result

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.frame

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/Current

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.frame

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Resources

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.fr

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.fr

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/Current

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.fr

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Resources

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framewo

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/Current

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framewo

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Yams

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framewo

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current

@@ -0,0 +1 @@
+lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A

data/lib/jazzy/config.rb

@@ -324,6 +324,11 @@ 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

@@ -151,7 +151,6 @@ module Jazzy
       )
 
       prepare_output_dir(options.output, options.clean)
-      write_lint_report(undocumented, options)
 
       puts "#{coverage}\% documentation coverage " \
         "with #{undocumented.count} undocumented symbol" \
@@ -160,6 +159,8 @@ module Jazzy
       unless options.skip_documentation
         build_site(docs, coverage, options)
       end
+
+      write_lint_report(undocumented, options)
     end
 
     def self.relative_path_if_inside(path, base_path)
@@ -257,9 +258,8 @@ module Jazzy
     # @param [Number] coverage The documentation coverage percentage
     # @param [Config] options Build options
     def self.download_badge(coverage, options)
-      if options.hide_documentation_coverage
-        return
-      end
+      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')
@@ -304,15 +304,15 @@ module Jazzy
       abstract = (item.abstract || '') + (item.discussion || '')
       item_render = {
         name:                       item.name,
-        abstract:                   render_markdown(abstract),
+        abstract:                   abstract,
         declaration:                item.declaration,
         other_language_declaration: item.other_language_declaration,
         usr:                        item.usr,
         dash_type:                  item.type.dash_type,
         github_token_url:           gh_token_url(item, source_module),
-        default_impl_abstract:      render_markdown(item.default_impl_abstract),
+        default_impl_abstract:      item.default_impl_abstract,
         from_protocol_extension:    item.from_protocol_extension,
-        return:                     render_markdown(item.return),
+        return:                     item.return,
         parameters:                 (item.parameters if item.parameters.any?),
         url:                        (item.url if item.children.any?),
         start_line:                 item.start_line,
@@ -321,10 +321,6 @@ module Jazzy
       item_render.reject { |_, v| v.nil? }
     end
 
-    def self.render_markdown(markdown)
-      Jazzy.markdown.render(markdown) if markdown
-    end
-
     def self.make_task(mark, uid, items)
       {
         name: mark.name,
@@ -367,6 +363,12 @@ module Jazzy
         return document_markdown(source_module, doc_model, path_to_root)
       end
 
+      overview = (doc_model.abstract || '') + (doc_model.discussion || '')
+      alternative_abstract = doc_model.alternative_abstract
+      if alternative_abstract
+        overview = Jazzy.markdown.render(alternative_abstract) + overview
+      end
+
       doc = Doc.new # Mustache model instance
       doc[:custom_head] = Config.instance.custom_head
       doc[:disable_search] = Config.instance.disable_search
@@ -376,7 +378,7 @@ module Jazzy
       doc[:kind] = doc_model.type.name
       doc[:dash_type] = doc_model.type.dash_type
       doc[:declaration] = doc_model.declaration
-      doc[:overview] = Jazzy.markdown.render(doc_model.overview)
+      doc[:overview] = overview
       doc[:structure] = source_module.doc_structure
       doc[:tasks] = render_tasks(source_module, doc_model.children)
       doc[:module_name] = source_module.name

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/jazzy_markdown.rb

@@ -13,10 +13,9 @@ module Jazzy
                       .sub(/^-/, '')
                       .sub(/-$/, '')
 
-      "<a href='##{text_slug}' class='anchor' aria-hidden=true>" \
-        '<span class="header-anchor"></span>' \
-      '</a>' \
-      "<h#{header_level} id='#{text_slug}'>#{text}</h#{header_level}>\n"
+      "<h#{header_level} id='#{text_slug}' class='heading'>" \
+        "#{text}" \
+      "</h#{header_level}>\n"
     end
 
     # List from
@@ -104,6 +103,7 @@ module Jazzy
       strikethrough: true,
       space_after_headers: false,
       tables: true,
+      lax_spacing: true,
     }.freeze
   end
 

data/lib/jazzy/source_declaration.rb

@@ -77,10 +77,6 @@ module Jazzy
     attr_accessor :end_line
     attr_accessor :nav_order
 
-    def overview
-      "#{alternative_abstract}\n\n#{abstract}\n\n#{discussion}".strip
-    end
-
     def alternative_abstract
       if file = alternative_abstract_file
         Pathname(file).read

data/lib/jazzy/sourcekitten.rb

@@ -48,6 +48,7 @@ module Jazzy
   module SourceKitten
     @documented_count = 0
     @undocumented_decls = []
+    @default_abstract = Jazzy.markdown.render('Undocumented').freeze
 
     # Group root-level docs by custom categories (if any) and type
     def self.group_docs(docs)
@@ -93,7 +94,7 @@ module Jazzy
         SourceDeclaration.new.tap do |sd|
           sd.type     = SourceDeclaration::Type.overview
           sd.name     = name
-          sd.abstract = abstract
+          sd.abstract = Jazzy.markdown.render(abstract)
           sd.children = group
         end
       end
@@ -221,7 +222,7 @@ module Jazzy
       # @todo: Fix these
       declaration.line = nil
       declaration.column = nil
-      declaration.abstract = 'Undocumented'
+      declaration.abstract = @default_abstract
       declaration.parameters = []
       declaration.children = []
     end
@@ -497,7 +498,7 @@ module Jazzy
           end
           unless defaults.empty?
             proto_method.default_impl_abstract =
-              defaults.flat_map { |d| [d.abstract, d.discussion] }.join("\n\n")
+              defaults.flat_map { |d| [d.abstract, d.discussion] }.join
           end
         end
       end

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

@@ -262,6 +262,13 @@ header {
         padding-top: 15px;
       }
     }
+
+    .heading:before {
+      content: "";
+      display: block;
+      padding-top: $content_top_offset;
+      margin: -$content_top_offset 0 0;
+    }
   }
 }
 

data/spec/integration_spec.rb

@@ -66,7 +66,7 @@ CLIntegracon.configure do |c|
   # Ignore certain OSX files
   c.ignores '.DS_Store'
   c.ignores '.git'
-  c.ignores %r{^(?!(docs/|execution_output.txt))}
+  c.ignores %r{^(?!((api-)?docs/|execution_output.txt))}
   c.ignores '*.tgz'
 
   # Remove absolute paths from output

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.0
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-21 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -181,18 +181,27 @@ files:
 - images/screenshot.jpg
 - jazzy.gemspec
 - lib/jazzy.rb
+- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Resources
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/SourceKittenFramework
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Commandant
+- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Resources
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Commandant
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Resources/Info.plist
+- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/Current
+- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Resources
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Result
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Resources/Info.plist
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Result
+- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/Current
+- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Resources
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/Resources/Info.plist
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/SWXMLHash
+- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/Current
+- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Resources
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/A/Resources/Info.plist
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/A/Yams
+- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/Current
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Yams
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCore.dylib
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCoreGraphics.dylib
@@ -203,6 +212,7 @@ files:
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftObjectiveC.dylib
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Resources/Info.plist
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/SourceKittenFramework
+- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current
 - lib/jazzy/SourceKitten/Rakefile
 - lib/jazzy/SourceKitten/bin/sourcekitten
 - lib/jazzy/config.rb
@@ -281,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Soulful docs for Swift & Objective-C.