jazzy 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb21ccc6282d1d4495ad8959db04ada3404dd060
-  data.tar.gz: 9d241f8a3d561bb49888290a672b9e95e7652217
+  metadata.gz: 09d1714bfe2ecc1fa4759c51094866893caf0e1d
+  data.tar.gz: 6e447e7da342c775039b2816f0a3838fe3e3bdae
 SHA512:
-  metadata.gz: 1126cc4f6733015c768f19be81a950b513532a4a296b5dbe33a627c5809938575c930e945f49830c0d5b13b05830207c8a3a3b34207b4b111c5ad0fcea46f307
-  data.tar.gz: 0bd4c2847a2534271ff3d123b2b62aff6e9560f47e019edf6753190aaacaeaa7f78493c5fd9a2127aa5afaf42e1c4d9b6a000c0d0c6265179d77497274e08c99
+  metadata.gz: cacce7a31c93f19765926d5f40462cac358c573d7312e74f784590ce38c0c918acaa812f15c5c5e37b90b6cc27e9f8123f6b88a1dce8e207a544523402787b45
+  data.tar.gz: 6a362da7dd06266d0374aee0f8e50f5d3afbc52cf3e30bfa6520590b7782d371f599f70ac4eb277b695a05b6b130386455525f577d7b8b4f0b226247ceae57d5

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+## 0.3.2
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* None.
+
+##### Bug Fixes
+
+* Fixed an issue that prevented building projects with different schema & module
+  names.  
+  [JP Simard](https://github.com/jpsim)
+  [#259](https://github.com/realm/jazzy/issues/259)
+
+* Hide documentation coverage from header using `--hide-documentation-coverage`.  
+  [mbogh](https://github.com/mbogh)
+  [#129](https://github.com/realm/jazzy/issues/297)
+
+* Print a more informative error when unable to find an Xcode that has the
+  requested Swift version.  
+  [Samuel Giddins])https://github.com/segiddins
+
+
 ## 0.3.1
 
 ##### Breaking

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.3.1)
+    jazzy (0.3.2)
       cocoapods (~> 0.38)
       mustache (~> 0.99)
       open4
@@ -66,7 +66,7 @@ GEM
     json (1.8.3)
     liferaft (0.0.4)
     metaclass (0.0.4)
-    minitest (5.8.0)
+    minitest (5.8.1)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.2)
@@ -84,8 +84,8 @@ GEM
       bacon (~> 1.2)
     rainbow (2.0.0)
     rake (10.3.2)
-    redcarpet (3.3.2)
-    rouge (1.9.0)
+    redcarpet (3.3.3)
+    rouge (1.10.1)
     rubocop (0.26.1)
       astrolabe (~> 1.3)
       parser (>= 2.2.0.pre.4, < 3.0)

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>15A282b</string>
+	<string>15B30a</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>7A218</string>
+	<string>7A1001</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>0700</string>
+	<string>0701</string>
 	<key>DTXcodeBuild</key>
-	<string>7A218</string>
+	<string>7A1001</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>15A282b</string>
+	<string>15B30a</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>7A218</string>
+	<string>7A1001</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>0700</string>
+	<string>0701</string>
 	<key>DTXcodeBuild</key>
-	<string>7A218</string>
+	<string>7A1001</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>15A282b</string>
+	<string>15B30a</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>7A218</string>
+	<string>7A1001</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>0700</string>
+	<string>0701</string>
 	<key>DTXcodeBuild</key>
-	<string>7A218</string>
+	<string>7A1001</string>
 	<key>UIDeviceFamily</key>
 	<array>
 		<integer>1</integer>

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

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15A282b</string>
+	<string>15B30a</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>7A218</string>
+	<string>7A1001</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>0700</string>
+	<string>0701</string>
 	<key>DTXcodeBuild</key>
-	<string>7A218</string>
+	<string>7A1001</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2014 JP Simard. All rights reserved.</string>
 </dict>

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>15A282b</string>
+	<string>15B30a</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.5.0</string>
+	<string>0.5.1</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>7A218</string>
+	<string>7A1001</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>0700</string>
+	<string>0701</string>
 	<key>DTXcodeBuild</key>
-	<string>7A218</string>
+	<string>7A1001</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2015 SourceKitten. All rights reserved.</string>
 </dict>

data/lib/jazzy/config.rb

@@ -25,6 +25,7 @@ module Jazzy
     attr_accessor :version
     attr_accessor :min_acl
     attr_accessor :skip_undocumented
+    attr_accessor :hide_documentation_coverage
     attr_accessor :podspec
     attr_accessor :docset_icon
     attr_accessor :docset_path
@@ -48,6 +49,7 @@ module Jazzy
       self.version = '1.0'
       self.min_acl = SourceDeclaration::AccessControlLevel.public
       self.skip_undocumented = false
+      self.hide_documentation_coverage = false
       self.source_directory = Pathname.pwd
       self.excluded_files = []
       self.custom_categories = {}
@@ -158,6 +160,12 @@ module Jazzy
           config.skip_undocumented = skip_undocumented
         end
 
+        opt.on('--[no-]hide-documentation-coverage',
+               "Hide \"(X\% documented)\" from the generated documents",
+               ) do |hide_documentation_coverage|
+          config.hide_documentation_coverage = hide_documentation_coverage
+        end
+
         opt.on('--podspec FILEPATH') do |podspec|
           config.podspec = Pathname(podspec)
         end

data/lib/jazzy/doc_builder.rb

@@ -51,8 +51,8 @@ module Jazzy
         if podspec = options.podspec
           stdout = PodspecDocumenter.new(podspec).sourcekitten_output
         else
-          stdout = Dir.chdir(Config.instance.source_directory) do
-            arguments = ['doc'] + options.xcodebuild_arguments
+          stdout = Dir.chdir(options.source_directory) do
+            arguments = SourceKitten.arguments_from_options(options)
             SourceKitten.run_sourcekitten(arguments)
           end
         end
@@ -183,7 +183,8 @@ module Jazzy
       doc = Doc.new # Mustache model instance
       doc[:name] = source_module.name
       doc[:overview] = ReadmeGenerator.generate(source_module)
-      doc[:doc_coverage] = source_module.doc_coverage
+      doc[:doc_coverage] = source_module.doc_coverage unless
+        Config.instance.hide_documentation_coverage
       doc[:structure] = source_module.doc_structure
       doc[:module_name] = source_module.name
       doc[:author_name] = source_module.author_name
@@ -283,7 +284,8 @@ module Jazzy
       end
 
       doc = Doc.new # Mustache model instance
-      doc[:doc_coverage] = source_module.doc_coverage
+      doc[:doc_coverage] = source_module.doc_coverage unless
+        Config.instance.hide_documentation_coverage
       doc[:name] = doc_model.name
       doc[:kind] = doc_model.type.name
       doc[:dash_type] = doc_model.type.dash_type

data/lib/jazzy/gem_version.rb

@@ -1,3 +1,3 @@
 module Jazzy
-  VERSION = '0.3.1' unless defined? Jazzy::VERSION
+  VERSION = '0.3.2' unless defined? Jazzy::VERSION
 end

data/lib/jazzy/sourcekitten.rb

@@ -108,9 +108,22 @@ module Jazzy
       end
     end
 
+    # Builds SourceKitten arguments based on Jazzy options
+    def self.arguments_from_options(options)
+      arguments = ['doc']
+      unless options.module_name.empty?
+        arguments += ['--module-name', options.module_name]
+      end
+      arguments += options.xcodebuild_arguments
+      arguments
+    end
+
     # Run sourcekitten with given arguments and return STDOUT
     def self.run_sourcekitten(arguments)
-      xcode = XCInvoke::Xcode.find_swift_version(Config.instance.swift_version)
+      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
       bin_path = Pathname(__FILE__).parent + 'SourceKitten/bin/sourcekitten'
       output, _ = Executable.execute_command(bin_path, arguments, true,
                                              env: xcode.as_env)
@@ -230,7 +243,7 @@ module Jazzy
     def self.make_source_declarations(docs)
       declarations = []
       current_mark = SourceMark.new
-      docs.each do |doc|
+      Array(docs).each do |doc|
         if doc.key?('key.diagnostic_stage')
           declarations += make_source_declarations(doc['key.substructure'])
           next

data/lib/jazzy/templates/header.mustache

@@ -1,6 +1,6 @@
 <header>
   <div class="content-wrapper">
-    <p><a href="{{path_to_root}}index.html">{{module_name}} Docs</a> ({{doc_coverage}}% documented)</p>
+    <p><a href="{{path_to_root}}index.html">{{module_name}} Docs</a>{{#doc_coverage}} ({{doc_coverage}}% documented){{/doc_coverage}}</p>
     {{#github_url}}
     <p class="header-right"><a href="{{github_url}}"><img src="{{path_to_root}}img/gh.png"/>View on GitHub</a></p>
     {{/github_url}}

data/spec/integration_spec.rb

@@ -177,7 +177,8 @@ describe_cli 'jazzy' do
                             '-u https://github.com/realm/jazzy ' \
                             '-g https://github.com/realm/jazzy ' \
                             '-x -dry-run ' \
-                            '--min-acl private'
+                            '--min-acl private ' \
+                            '--hide-documentation-coverage'
     end
   end if !travis_swift || travis_swift == '2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-11 00:00:00.000000000 Z
+date: 2015-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods