jazzy 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 549602405c7fd774831d722881c5c8d89696945c
-  data.tar.gz: 02dd41a23da8915336f4e3251f9ba72f9579fe97
+  metadata.gz: b069018d7703d12f82c015af5684c9e3ca3fbc41
+  data.tar.gz: 7524e6e46b8bd59be148df44ea5fdfb873c0c1a5
 SHA512:
-  metadata.gz: 58930f702701094f66113af5fe7447737c738ef23a2a57672329ea3c09e600aaacf6ec7e232acf31d3493ca19db72afc4fd9531fac706dd2b84722ddc52ebbf5
-  data.tar.gz: f39d276d4a19aa87de055a5772b8a77f1ceb2ff20da0dce3405b8d0c1a86620db96a7e5153073f4b6c3e8dc708325cadfdfe3338418a96e77ce1565fa096cdee
+  metadata.gz: 3db8afa17755cd9e7e7bc4594fd3ab39e55661b70a3dab637b3732d4647d1866abfc94fb2b2a2910f4b6c5bb0c04e2ee14464fafb8389f19d50e140c5f6bfc5b
+  data.tar.gz: 5c8e88b4b8e53373d7475be94c0bdc718b1eed0bc5b0d4615feebb7370fc2111d2bdf186578026ad4097a95517368f155e405aac8ed31bfb24c66f87e3eb0eca

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.0.17)
+    jazzy (0.0.18)
       activesupport (~> 4.1)
       mustache (~> 0.99)
       nokogiri (~> 1.6)
@@ -13,11 +13,11 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (4.1.8)
-      i18n (~> 0.6, >= 0.6.9)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.1)
+      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     addressable (2.3.6)
     ast (2.0.0)
@@ -31,7 +31,7 @@ GEM
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
     diffy (3.0.7)
-    i18n (0.6.11)
+    i18n (0.7.0)
     json (1.8.1)
     metaclass (0.0.4)
     mini_portile (0.6.1)

data/lib/jazzy/doc_builder.rb

@@ -97,7 +97,7 @@ module Jazzy
       output_dir = options.output
       prepare_output_dir(output_dir, options.clean)
 
-      (docs, coverage) = SourceKitten.parse(
+      (docs, coverage, undocumented) = SourceKitten.parse(
         sourcekitten_output,
         options.min_acl,
       )
@@ -112,6 +112,8 @@ module Jazzy
       source_module = SourceModule.new(options, docs, structure, coverage)
       build_docs(output_dir, source_module.docs, source_module)
 
+      write_undocumented_file(undocumented, output_dir)
+
       copy_assets(output_dir)
 
       DocsetBuilder.new(output_dir, source_module).build!
@@ -119,6 +121,26 @@ module Jazzy
       puts "jam out ♪♫ to your fresh new docs in `#{output_dir}`"
     end
 
+    def self.write_undocumented_file(undocumented, output_dir)
+      (output_dir + 'undocumented.txt').open('w') do |f|
+        tokens_by_file = undocumented.group_by do |d|
+          if d['key.filepath']
+            Pathname.new(d['key.filepath']).basename.to_s
+          else
+            d['key.modulename'] || ''
+          end
+        end
+        tokens_by_file.each_key do |file|
+          f.write(file + "\n")
+          tokens_by_file[file].each do |token|
+            decl = token['key.parsed_declaration'] ||
+              token['key.annotated_decl'].gsub(/<[^>]+>/, '')
+            f.write("\t" + decl + "\n")
+          end
+        end
+      end
+    end
+
     def self.copy_assets(destination)
       origin = Pathname(__FILE__).parent + '../../lib/jazzy/assets/.'
       FileUtils.cp_r(origin, destination)

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/sourcekitten.rb

@@ -10,8 +10,8 @@ require 'jazzy/highlighter'
 module Jazzy
   # This module interacts with the sourcekitten command-line executable
   module SourceKitten
-    @documented = 0
-    @undocumented = 0
+    @documented_count = 0
+    @undocumented_tokens = []
 
     # Group root-level docs by type and add as children to a group doc element
     def self.group_docs(docs, type)
@@ -75,7 +75,7 @@ module Jazzy
     end
 
     def self.process_undocumented_token(doc, declaration)
-      @undocumented += 1
+      @undocumented_tokens << doc
       return nil unless documented_child?(doc)
       make_default_doc_info(declaration)
     end
@@ -95,7 +95,7 @@ module Jazzy
       return nil unless should_document?(doc)
       xml_key = 'key.doc.full_as_xml'
       return process_undocumented_token(doc, declaration) unless doc[xml_key]
-      @documented += 1
+      @documented_count += 1
 
       xml = Nokogiri::XML(doc[xml_key]).root
       declaration.line = XMLHelper.attribute(xml, 'line').to_i
@@ -163,8 +163,9 @@ module Jazzy
     # rubocop:enable Metrics/MethodLength
 
     def self.doc_coverage
-      return 0 if @documented == 0 && @undocumented == 0
-      (100 * @documented) / (@undocumented + @documented)
+      return 0 if @documented_count == 0 && @undocumented_tokens.count == 0
+      (100 * @documented_count) /
+        (@undocumented_tokens.count + @documented_count)
     end
 
     # Parse sourcekitten STDOUT output as JSON
@@ -176,7 +177,7 @@ module Jazzy
       SourceDeclaration::Type.all.each do |type|
         docs = group_docs(docs, type)
       end
-      [make_doc_urls(docs, []), doc_coverage]
+      [make_doc_urls(docs, []), doc_coverage, @undocumented_tokens]
     end
   end
 end

data/spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/undocumented.txt

@@ -0,0 +1,18 @@
+Alamofire.swift
+	func queryComponents(key: String, _ value: AnyObject) -> [(String, String)]
+	func escape(string: String) -> String
+	public var URLString: String
+	public var URLString: String
+	public var URLRequest: NSURLRequest
+	struct Singleton
+	required public init(configuration: NSURLSessionConfiguration? = nil)
+	deinit
+	class SessionDelegate: NSObject, NSURLSessionDelegate, NSURLSessionTaskDelegate, NSURLSessionDataDelegate, NSURLSessionDownloadDelegate
+	class TaskDelegate: NSObject, NSURLSessionTaskDelegate
+	class DataTaskDelegate: TaskDelegate, NSURLSessionDataDelegate
+	class UploadTaskDelegate: DataTaskDelegate
+	class DownloadTaskDelegate: TaskDelegate, NSURLSessionDownloadDelegate
+	func cURLRepresentation() -> String
+NSURL.h
+	class NSURL : NSObject, NSSecureCoding, NSCoding, NSCopying
+	class NSURLComponents : NSObject, NSCopying

data/spec/integration_specs/document_alamofire/after/docs/undocumented.txt

@@ -0,0 +1,18 @@
+Alamofire.swift
+	func queryComponents(key: String, _ value: AnyObject) -> [(String, String)]
+	func escape(string: String) -> String
+	public var URLString: String
+	public var URLString: String
+	public var URLRequest: NSURLRequest
+	struct Singleton
+	required public init(configuration: NSURLSessionConfiguration? = nil)
+	deinit
+	class SessionDelegate: NSObject, NSURLSessionDelegate, NSURLSessionTaskDelegate, NSURLSessionDataDelegate, NSURLSessionDownloadDelegate
+	class TaskDelegate: NSObject, NSURLSessionTaskDelegate
+	class DataTaskDelegate: TaskDelegate, NSURLSessionDataDelegate
+	class UploadTaskDelegate: DataTaskDelegate
+	class DownloadTaskDelegate: TaskDelegate, NSURLSessionDownloadDelegate
+	func cURLRepresentation() -> String
+NSURL.h
+	class NSURL : NSObject, NSSecureCoding, NSCoding, NSCopying
+	class NSURLComponents : NSObject, NSCopying

data/spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/undocumented.txt

@@ -0,0 +1,3 @@
+Classes.swift
+	class UndocumentedTopLevelClass
+	enum UndocumentedEnum

data/spec/integration_specs/misc_jazzy_features/after/docs/undocumented.txt

@@ -0,0 +1,3 @@
+Classes.swift
+	class UndocumentedTopLevelClass
+	enum UndocumentedEnum

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2014-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
@@ -243,6 +243,7 @@ files:
 - spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/jquery.min.js
 - spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/js/jazzy.js
 - spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/js/jquery.min.js
+- spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/undocumented.txt
 - spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/docSet.dsidx.csv
 - spec/integration_specs/document_alamofire/after/docs/docsets/Alamofire.xml
 - spec/integration_specs/document_alamofire/after/docs/img/carat.png
@@ -251,6 +252,7 @@ files:
 - spec/integration_specs/document_alamofire/after/docs/index.html
 - spec/integration_specs/document_alamofire/after/docs/js/jazzy.js
 - spec/integration_specs/document_alamofire/after/docs/js/jquery.min.js
+- spec/integration_specs/document_alamofire/after/docs/undocumented.txt
 - spec/integration_specs/document_alamofire/after/execution_output.txt
 - spec/integration_specs/misc_jazzy_features/after/docs/Classes.html
 - spec/integration_specs/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html
@@ -283,6 +285,7 @@ files:
 - spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/jquery.min.js
 - spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/js/jazzy.js
 - spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/js/jquery.min.js
+- spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/undocumented.txt
 - spec/integration_specs/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/docSet.dsidx.csv
 - spec/integration_specs/misc_jazzy_features/after/docs/img/carat.png
 - spec/integration_specs/misc_jazzy_features/after/docs/img/dash.png
@@ -290,6 +293,7 @@ files:
 - spec/integration_specs/misc_jazzy_features/after/docs/index.html
 - spec/integration_specs/misc_jazzy_features/after/docs/js/jazzy.js
 - spec/integration_specs/misc_jazzy_features/after/docs/js/jquery.min.js
+- spec/integration_specs/misc_jazzy_features/after/docs/undocumented.txt
 - spec/integration_specs/misc_jazzy_features/after/execution_output.txt
 - spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures.xcodeproj/project.pbxproj
 - spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures.xcodeproj/project.xcworkspace/contents.xcworkspacedata