jazzy 0.5.0 → 0.6.0

data/lib/jazzy/source_mark.rb

@@ -10,7 +10,7 @@ module Jazzy
       # Format: 'MARK: - NAME -' with dashes optional
       mark_string.sub!(/^MARK: /, '')
 
-      if mark_string.length == 0
+      if mark_string.empty?
         # Empty
         return
       elsif mark_string == '-'

data/lib/jazzy/sourcekitten.rb

@@ -78,11 +78,11 @@ module Jazzy
           # 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 #{Config.instance.xcodebuild_arguments.shelljoin}`."
+            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 ' \
+                 "#{Config.instance.xcodebuild_arguments.shelljoin}`."
           end
           id = doc.usr
           unless id
@@ -119,13 +119,15 @@ module Jazzy
       arguments = ['doc']
       if options.objc_mode
         if options.xcodebuild_arguments.empty?
-          arguments += ['--objc', options.umbrella_header.to_s, '-x',
+          arguments += ['--objc', options.umbrella_header.to_s, '--', '-x',
                         'objective-c', '-isysroot',
                         `xcrun --show-sdk-path --sdk #{options.sdk}`.chomp,
                         '-I', options.framework_root.to_s]
         end
       elsif !options.module_name.empty?
-        arguments += ['--module-name', options.module_name]
+        arguments += ['--module-name', options.module_name, '--']
+      else
+        arguments += ['--']
       end
       arguments + options.xcodebuild_arguments
     end
@@ -319,20 +321,25 @@ module Jazzy
     # Two declarations get merged if they have the same deduplication key.
     def self.deduplication_key(decl)
       if decl.type.swift_extensible? || decl.type.swift_extension?
-        [decl.usr]
+        [decl.usr, decl.name]
+      elsif decl.type.objc_class? || decl.type.objc_category?
+        name, _ = decl.objc_category_name || decl.name
+        [name, :objc_class_and_categories]
       else
-        [decl.usr, decl.type.kind]
+        [decl.usr, decl.name, decl.type.kind]
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     # Merges all of the given types and extensions into a single document.
     def self.merge_declarations(decls)
-      extensions, typedecls = decls.partition { |d| d.type.swift_extension? }
+      extensions, typedecls = decls.partition { |d| d.type.extension? }
 
       if typedecls.size > 1
         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(', ')
+             typedecls.map { |t| "#{t.type.name.downcase} #{t.name}" }
+             .join(', ')
       end
       typedecl = typedecls.first
 
@@ -340,6 +347,13 @@ module Jazzy
         merge_default_implementations_into_protocol(typedecl, extensions)
         mark_members_from_protocol_extension(extensions)
         extensions.reject! { |ext| ext.children.empty? }
+      elsif typedecl && typedecl.type.objc_class?
+        # Mark children merged from categories with the name of category
+        # (unless they already have a mark)
+        extensions.each do |ext|
+          _, category_name = ext.objc_category_name
+          ext.children.each { |c| c.mark.name ||= category_name }
+        end
       end
 
       decls = typedecls + extensions
@@ -351,6 +365,7 @@ module Jazzy
         end
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     # If any of the extensions provide default implementations for methods in
     # the given protocol, merge those members into the protocol doc instead of
@@ -392,8 +407,8 @@ module Jazzy
     def self.name_match(name_part, docs)
       return nil unless name_part
       wildcard_expansion = Regexp.escape(name_part)
-                           .gsub('\.\.\.', '[^)]*')
-                           .gsub(/&lt;.*&gt;/, '')
+                                 .gsub('\.\.\.', '[^)]*')
+                                 .gsub(/&lt;.*&gt;/, '')
       whole_name_pat = /\A#{wildcard_expansion}\Z/
       docs.find do |doc|
         whole_name_pat =~ doc.name

data/spec/integration_spec.rb

@@ -91,7 +91,6 @@ describe_cli 'jazzy' do
   travis_swift = ENV['TRAVIS_SWIFT_VERSION']
 
   require 'shellwords'
-  # rubocop:disable Metrics/LineLength
   realm_head = <<-HTML
 <link rel="icon" href="https://realm.io/img/favicon.ico">
 <link rel="apple-touch-icon-precomposed" sizes="57x57" href="https://realm.io/img/favicon-57x57.png" />
@@ -111,7 +110,6 @@ describe_cli 'jazzy' do
   ga('send', 'pageview');
 </script>
   HTML
-  # rubocop:enable Metrics/LineLength
 
   describe 'jazzy objective-c' do
     describe 'Creates Realm Objective-C docs' do
@@ -138,9 +136,14 @@ describe_cli 'jazzy' do
                             '--framework-root . ' \
                             "--head #{realm_head.shellescape}"
     end
+
+    describe 'Creates docs for ObjC project with a variety of contents' do
+      behaves_like cli_spec 'misc_jazzy_objc_features',
+                            '--theme fullwidth'
+    end
   end
 
-  describe 'jazzy swift 2.1.1' do
+  describe 'jazzy swift 2.2' do
     describe 'Creates docs for a podspec with dependencies and subspecs' do
       behaves_like cli_spec 'document_moya_podspec', '--podspec=Moya.podspec'
     end
@@ -163,7 +166,6 @@ describe_cli 'jazzy' do
       realm_version = ''
       Dir.chdir(ROOT + 'spec/integration_specs/document_realm_swift/before') do
         realm_version = `./build.sh get-version`.chomp
-        `REALM_SWIFT_VERSION=2.1.1 ./build.sh set-swift-version`
       end
       behaves_like cli_spec 'document_realm_swift',
                             '--author Realm ' \
@@ -181,9 +183,14 @@ describe_cli 'jazzy' do
                             "--head #{realm_head.shellescape}"
     end
 
+    describe 'Creates Siesta docs' do
+      behaves_like cli_spec 'document_siesta',
+                            '--output api-docs' # Siesta already has Docs/
+    end
+
     describe 'Creates docs for Swift project with a variety of contents' do
       behaves_like cli_spec 'misc_jazzy_features',
                             '-x -dry-run --theme fullwidth'
     end
-  end if !travis_swift || travis_swift == '2.1.1'
+  end if !travis_swift || travis_swift == '2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-03 00:00:00.000000000 Z
+date: 2016-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -116,14 +116,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -180,18 +180,12 @@ files:
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Commandant
 - 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/Curry.framework/Curry
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Curry.framework/Versions/A/Curry
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Curry.framework/Versions/A/Resources/Info.plist
 - 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/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/SwiftXPC.framework/SwiftXPC
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Resources/Info.plist
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/SwiftXPC
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCore.dylib
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCoreGraphics.dylib
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDarwin.dylib
@@ -279,4 +273,3 @@ signing_key:
 specification_version: 4
 summary: Soulful docs for Swift & Objective-C.
 test_files: []
-has_rdoc: 

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Curry.framework/Versions/A/Resources/Info.plist

@@ -1,49 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>BuildMachineOSBuild</key>
-	<string>15C50</string>
-	<key>CFBundleDevelopmentRegion</key>
-	<string>en</string>
-	<key>CFBundleExecutable</key>
-	<string>Curry</string>
-	<key>CFBundleIdentifier</key>
-	<string>com.thoughtbot.Curry</string>
-	<key>CFBundleInfoDictionaryVersion</key>
-	<string>6.0</string>
-	<key>CFBundleName</key>
-	<string>Curry</string>
-	<key>CFBundlePackageType</key>
-	<string>FMWK</string>
-	<key>CFBundleShortVersionString</key>
-	<string>1.4.0</string>
-	<key>CFBundleSignature</key>
-	<string>????</string>
-	<key>CFBundleSupportedPlatforms</key>
-	<array>
-		<string>MacOSX</string>
-	</array>
-	<key>CFBundleVersion</key>
-	<string>1</string>
-	<key>DTCompiler</key>
-	<string>com.apple.compilers.llvm.clang.1_0</string>
-	<key>DTPlatformBuild</key>
-	<string>7C68</string>
-	<key>DTPlatformVersion</key>
-	<string>GM</string>
-	<key>DTSDKBuild</key>
-	<string>15C43</string>
-	<key>DTSDKName</key>
-	<string>macosx10.11</string>
-	<key>DTXcode</key>
-	<string>0720</string>
-	<key>DTXcodeBuild</key>
-	<string>7C68</string>
-	<key>UIDeviceFamily</key>
-	<array>
-		<integer>1</integer>
-		<integer>2</integer>
-	</array>
-</dict>
-</plist>

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Resources/Info.plist

@@ -1,46 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>BuildMachineOSBuild</key>
-	<string>15C50</string>
-	<key>CFBundleDevelopmentRegion</key>
-	<string>en</string>
-	<key>CFBundleExecutable</key>
-	<string>SwiftXPC</string>
-	<key>CFBundleIdentifier</key>
-	<string>com.jpsim.SwiftXPC</string>
-	<key>CFBundleInfoDictionaryVersion</key>
-	<string>6.0</string>
-	<key>CFBundleName</key>
-	<string>SwiftXPC</string>
-	<key>CFBundlePackageType</key>
-	<string>FMWK</string>
-	<key>CFBundleShortVersionString</key>
-	<string>1.1.0</string>
-	<key>CFBundleSignature</key>
-	<string>????</string>
-	<key>CFBundleSupportedPlatforms</key>
-	<array>
-		<string>MacOSX</string>
-	</array>
-	<key>CFBundleVersion</key>
-	<string>1</string>
-	<key>DTCompiler</key>
-	<string>com.apple.compilers.llvm.clang.1_0</string>
-	<key>DTPlatformBuild</key>
-	<string>7C68</string>
-	<key>DTPlatformVersion</key>
-	<string>GM</string>
-	<key>DTSDKBuild</key>
-	<string>15C43</string>
-	<key>DTSDKName</key>
-	<string>macosx10.11</string>
-	<key>DTXcode</key>
-	<string>0720</string>
-	<key>DTXcodeBuild</key>
-	<string>7C68</string>
-	<key>NSHumanReadableCopyright</key>
-	<string>Copyright © 2014 JP Simard. All rights reserved.</string>
-</dict>
-</plist>