jazzy 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ba1de18fa3f65a96e4194a16af54548702703a3
-  data.tar.gz: b672b6be8ae8d3dd5e7fb01b3b38e8193f64e2f3
+  metadata.gz: 8d85303f765a7df28885d3fcdd9d7d8d89d502c8
+  data.tar.gz: b03826e493810d8d6fa62f1bb6c3877852d1cdf7
 SHA512:
-  metadata.gz: 750b810f71f2b796acfab8b17a0f4b74fc27efd22098086a77d469a035b5a977921bea452e93603c05ede5a14e9e2fcef39286f491e504ac2036b47a0ab24a5f
-  data.tar.gz: 82dd5f2f81eaac159ce85f4444e72407a09dbb5dbfcc151a4e9c4ff2866ac8e06a6aa5893a61548d4c3ca8168a6176303ee77c8c62f4851a5e9bdab228c55498
+  metadata.gz: b6daabf69f85b3a83aa8db1598b4a307718b9056b176b580dd981e15d22e3a27fc0dda6b12582eac8af2067a1916bfbb94963ef0666fe18346b91f5f5f29acad
+  data.tar.gz: 060d7221d8c6a827d78bba090c525740febb55c4323fc71aa626af598cb6562836c0103f71819078c123a42913cd95267c2ec90b3715e392a65e360c7d46ed76

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+## 0.6.1
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Objective-C documentation now also includes Swift declarations.  
+  [JP Simard](https://github.com/jpsim)
+  [#136](https://github.com/realm/jazzy/issues/136)
+* Default to the Xcode version selected in `xcode-select` if no Swift version is
+  specified.  
+  [Samuel Giddins](https://github.com/segiddins)
+  [#427](https://github.com/realm/jazzy/issues/427)
+
+##### Bug Fixes
+
+* Uses GitHub-Flavored Markdown syntax for anchors when rendering README pages.  
+  [Zachary Waldowski](https://github.com/zwaldowski)
+  [#524](https://github.com/realm/jazzy/issues/524)
+* Fix crash when using unexposed declarations in Objective-C.  
+  [JP Simard](https://github.com/jpsim)
+  [#543](https://github.com/realm/jazzy/issues/543)
+* No longer document Swift extensions on types with an ACL lower than `min-acl`
+  when they contain `MARK`s.  
+  [JP Simard](https://github.com/jpsim)
+  [#544](https://github.com/realm/jazzy/issues/544)
+
 ## 0.6.0
 
 ##### Breaking
@@ -204,7 +233,7 @@
 
 * Print a more informative error when unable to find an Xcode that has the
   requested Swift version.  
-  [Samuel Giddins])https://github.com/segiddins
+  [Samuel Giddins](https://github.com/segiddins)
 
 
 ## 0.3.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.6.0)
+    jazzy (0.6.1)
       cocoapods (~> 0.39)
       mustache (~> 0.99)
       open4
@@ -71,7 +71,7 @@ GEM
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.2)
       mocha (>= 0.13.0)
-    molinillo (0.4.4)
+    molinillo (0.4.5)
     mustache (0.99.8)
     nap (1.1.0)
     netrc (0.7.8)

data/README.md

@@ -34,6 +34,10 @@ you wish to document. It must be installed in a location indexed by Spotlight.
 
 Run `jazzy` from your command line. Run `jazzy -h` for a list of additional options.
 
+If your Swift module is the first thing to build, and it builds fine when running
+`xcodebuild` without any arguments from the root of your project, then just running
+`jazzy` (without any arguments) from the root of your project should succeed too!
+
 You can set options for your project’s documentation in a configuration file,
 `.jazzy.yaml` by default. For a detailed explanation and an exhaustive list of
 all available options, run `jazzy --help config`.

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

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15E65</string>
+	<string>15F34</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -17,7 +17,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>0.8.2</string>
+	<string>0.9.0</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleSupportedPlatforms</key>
@@ -29,7 +29,7 @@
 	<key>DTCompiler</key>
 	<string>com.apple.compilers.llvm.clang.1_0</string>
 	<key>DTPlatformBuild</key>
-	<string>7D175</string>
+	<string>7D1014</string>
 	<key>DTPlatformVersion</key>
 	<string>GM</string>
 	<key>DTSDKBuild</key>
@@ -37,9 +37,9 @@
 	<key>DTSDKName</key>
 	<string>macosx10.11</string>
 	<key>DTXcode</key>
-	<string>0730</string>
+	<string>0731</string>
 	<key>DTXcodeBuild</key>
-	<string>7D175</string>
+	<string>7D1014</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2014 Carthage. All rights reserved.</string>
 </dict>

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

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15E65</string>
+	<string>15F34</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -29,7 +29,7 @@
 	<key>DTCompiler</key>
 	<string>com.apple.compilers.llvm.clang.1_0</string>
 	<key>DTPlatformBuild</key>
-	<string>7D175</string>
+	<string>7D1014</string>
 	<key>DTPlatformVersion</key>
 	<string>GM</string>
 	<key>DTSDKBuild</key>
@@ -37,9 +37,9 @@
 	<key>DTSDKName</key>
 	<string>macosx10.11</string>
 	<key>DTXcode</key>
-	<string>0730</string>
+	<string>0731</string>
 	<key>DTXcodeBuild</key>
-	<string>7D175</string>
+	<string>7D1014</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2015 Rob Rix. All rights reserved.</string>
 </dict>

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

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15E65</string>
+	<string>15F34</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -29,7 +29,7 @@
 	<key>DTCompiler</key>
 	<string>com.apple.compilers.llvm.clang.1_0</string>
 	<key>DTPlatformBuild</key>
-	<string>7D175</string>
+	<string>7D1014</string>
 	<key>DTPlatformVersion</key>
 	<string>GM</string>
 	<key>DTSDKBuild</key>
@@ -37,9 +37,9 @@
 	<key>DTSDKName</key>
 	<string>macosx10.11</string>
 	<key>DTXcode</key>
-	<string>0730</string>
+	<string>0731</string>
 	<key>DTXcodeBuild</key>
-	<string>7D175</string>
+	<string>7D1014</string>
 	<key>UIDeviceFamily</key>
 	<array>
 		<integer>1</integer>

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

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15E65</string>
+	<string>15F34</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -17,7 +17,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>0.12.0</string>
+	<string>0.12.2</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleSupportedPlatforms</key>
@@ -29,7 +29,7 @@
 	<key>DTCompiler</key>
 	<string>com.apple.compilers.llvm.clang.1_0</string>
 	<key>DTPlatformBuild</key>
-	<string>7D175</string>
+	<string>7D1014</string>
 	<key>DTPlatformVersion</key>
 	<string>GM</string>
 	<key>DTSDKBuild</key>
@@ -37,9 +37,9 @@
 	<key>DTSDKName</key>
 	<string>macosx10.11</string>
 	<key>DTXcode</key>
-	<string>0730</string>
+	<string>0731</string>
 	<key>DTXcodeBuild</key>
-	<string>7D175</string>
+	<string>7D1014</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2015 SourceKitten. All rights reserved.</string>
 </dict>

data/lib/jazzy/config.rb

@@ -159,7 +159,7 @@ module Jazzy
 
     config_attr :swift_version,
       command_line: '--swift-version VERSION',
-      default: '2.2',
+      default: nil,
       parse: ->(v) do
         raise 'jazzy only supports Swift 2.0 or later.' if v.to_f < 2
         v

data/lib/jazzy/doc_builder.rb

@@ -284,19 +284,20 @@ module Jazzy
       # Combine abstract and discussion into abstract
       abstract = (item.abstract || '') + (item.discussion || '')
       item_render = {
-        name:                    item.name,
-        abstract:                render_markdown(abstract),
-        declaration:             item.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),
-        from_protocol_extension: item.from_protocol_extension,
-        return:                  render_markdown(item.return),
-        parameters:              (item.parameters if item.parameters.any?),
-        url:                     (item.url if item.children.any?),
-        start_line:              item.start_line,
-        end_line:                item.end_line,
+        name:                       item.name,
+        abstract:                   render_markdown(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),
+        from_protocol_extension:    item.from_protocol_extension,
+        return:                     render_markdown(item.return),
+        parameters:                 (item.parameters if item.parameters.any?),
+        url:                        (item.url if item.children.any?),
+        start_line:                 item.start_line,
+        end_line:                   item.end_line,
       }
       item_render.reject { |_, v| v.nil? }
     end

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/jazzy_markdown.rb

@@ -8,10 +8,10 @@ module Jazzy
     include Rouge::Plugins::Redcarpet
 
     def header(text, header_level)
-      text_slug = text.gsub(/[^a-zA-Z0-9]+/, '_')
+      text_slug = text.gsub(/[^\w]+/, '-')
                       .downcase
-                      .sub(/^_/, '')
-                      .sub(/_$/, '')
+                      .sub(/^-/, '')
+                      .sub(/-$/, '')
 
       "<a href='##{text_slug}' class='anchor' aria-hidden=true>" \
         '<span class="header-anchor"></span>' \

data/lib/jazzy/source_declaration.rb

@@ -54,6 +54,7 @@ module Jazzy
     attr_accessor :usr
     attr_accessor :name
     attr_accessor :declaration
+    attr_accessor :other_language_declaration
     attr_accessor :abstract
     attr_accessor :default_impl_abstract
     attr_accessor :from_protocol_extension

data/lib/jazzy/source_declaration/type.rb

@@ -104,6 +104,10 @@ module Jazzy
       TYPES = {
         # Objective-C
 
+        'sourcekitten.source.lang.objc.decl.unexposed' => {
+          jazzy: 'Unexposed',
+          dash: 'Unexposed',
+        }.freeze,
         'sourcekitten.source.lang.objc.decl.category' => {
           jazzy: 'Category',
           dash: 'Extension',

data/lib/jazzy/sourcekitten.rb

@@ -134,9 +134,12 @@ module Jazzy
 
     # Run sourcekitten with given arguments and return STDOUT
     def self.run_sourcekitten(arguments)
-      swift_version = Config.instance.swift_version
-      unless xcode = XCInvoke::Xcode.find_swift_version(swift_version)
-        raise "Unable to find an Xcode with swift version #{swift_version}."
+      if swift_version = Config.instance.swift_version
+        unless xcode = XCInvoke::Xcode.find_swift_version(swift_version)
+          raise "Unable to find an Xcode with swift version #{swift_version}."
+        end
+      else
+        xcode = XCInvoke::Xcode.selected
       end
       bin_path = Pathname(__FILE__).parent + 'SourceKitten/bin/sourcekitten'
       output, = Executable.execute_command(bin_path, arguments, true,
@@ -169,7 +172,8 @@ module Jazzy
       return true if type.swift_enum_element?
       if type.swift_extension?
         return Array(doc['key.substructure']).any? do |subdoc|
-          should_document?(subdoc)
+          subtype = SourceDeclaration::Type.new(subdoc['key.kind'])
+          !subtype.mark? && should_document?(subdoc)
         end
       end
 
@@ -213,6 +217,8 @@ module Jazzy
       end
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
     def self.make_doc_info(doc, declaration)
       return unless should_document?(doc)
       unless doc['key.doc.full_as_xml']
@@ -225,6 +231,11 @@ module Jazzy
         doc['key.parsed_declaration'] || doc['key.doc.declaration'],
         Config.instance.objc_mode ? 'objc' : 'swift',
       )
+      if Config.instance.objc_mode && doc['key.swift_declaration']
+        declaration.other_language_declaration = Highlighter.highlight(
+          doc['key.swift_declaration'], 'swift'
+        )
+      end
       declaration.abstract = Jazzy.markdown.render(doc['key.doc.comment'] || '')
       declaration.discussion = ''
       declaration.return = make_paragraphs(doc, 'key.doc.result_discussion')
@@ -233,6 +244,8 @@ module Jazzy
 
       @documented_count += 1
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def self.make_substructure(doc, declaration)
       if doc['key.substructure']

data/lib/jazzy/themes/apple/templates/task.mustache

@@ -53,6 +53,12 @@
               <p class="aside-title">{{language}}</p>
               {{{declaration}}}
             </div>
+            {{#other_language_declaration}}
+            <div class="language">
+              <p class="aside-title">Swift</p>
+              {{{other_language_declaration}}}
+            </div>
+            {{/other_language_declaration}}
           </div>
           {{/declaration}}
           {{#parameters.count}}

data/lib/jazzy/themes/fullwidth/templates/task.mustache

@@ -53,6 +53,12 @@
               <p class="aside-title">{{language}}</p>
               {{{declaration}}}
             </div>
+            {{#other_language_declaration}}
+            <div class="language">
+              <p class="aside-title">Swift</p>
+              {{{other_language_declaration}}}
+            </div>
+            {{/other_language_declaration}}
           </div>
           {{/declaration}}
           {{#parameters.count}}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-06 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -191,6 +191,7 @@ files:
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDarwin.dylib
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDispatch.dylib
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftFoundation.dylib
+- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftIOKit.dylib
 - 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