jazzy 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b069018d7703d12f82c015af5684c9e3ca3fbc41
-  data.tar.gz: 7524e6e46b8bd59be148df44ea5fdfb873c0c1a5
+  metadata.gz: f5028341546a9eec4aae38995c657eef80a78d6e
+  data.tar.gz: 901bdc8c444a31d0f5bf7560384539e8631c5fe7
 SHA512:
-  metadata.gz: 3db8afa17755cd9e7e7bc4594fd3ab39e55661b70a3dab637b3732d4647d1866abfc94fb2b2a2910f4b6c5bb0c04e2ee14464fafb8389f19d50e140c5f6bfc5b
-  data.tar.gz: 5c8e88b4b8e53373d7475be94c0bdc718b1eed0bc5b0d4615feebb7370fc2111d2bdf186578026ad4097a95517368f155e405aac8ed31bfb24c66f87e3eb0eca
+  metadata.gz: 04e557511f3f4da5961fb5b34dd07ee5c7e7fbd377d6b87b45eac00c27b69a27d8421a6515ac94d47abdddbb2af03e1ddf583a9c3b36b0997203aa994be7ddf5
+  data.tar.gz: 3192502b4f65c2442861f924d49d2284aa7b81c1249b5a1a0ebc38c185f2f693bcdfd0ac69cb2e514a7628cef5e5517dddea3b1ef23ca53db625c78eb7e9208f

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+## 0.0.19
+
+[sourcekitten](https://github.com/jpsim/sourcekitten/compare/0.2.3...0.2.6)
+
+##### Breaking
+
+None.
+
+##### Enhancements
+
+* Added CHANGELOG.md.  
+  [JP Simard](https://github.com/jpsim)
+  [#125](https://github.com/realm/jazzy/issues/125)
+
+* Include parse errors in the JSON output & print to STDERR.  
+  [JP Simard](https://github.com/jpsim)
+  [jpsim/sourcekitten#16](https://github.com/jpsim/sourcekitten/issues/16)
+
+##### Bug Fixes
+
+* Fixed crash when files contained a declaration on the first line.  
+  [JP Simard](https://github.com/jpsim)
+  [jpsim/sourcekitten#14](https://github.com/jpsim/sourcekitten/issues/14)
+
+* Fixed invalid JSON issue when last file in an Xcode project failed to parse.  
+  [JP Simard](https://github.com/jpsim)
+
+* Fixed crash when attempting to parse the declaration of `extension Array`.  
+  [JP Simard](https://github.com/jpsim)
+  [#126](https://github.com/realm/jazzy/issues/126)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.0.18)
+    jazzy (0.0.19)
       activesupport (~> 4.1)
       mustache (~> 0.99)
       nokogiri (~> 1.6)

data/jazzy.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.version       = Jazzy::VERSION
   spec.authors       = ['JP Simard', 'Tim Anglade', 'Samuel Giddins']
   spec.email         = ['jp@realm.io']
-  spec.summary       = 'A soulful way to generate docs for Swift.'
-  spec.description   = 'A soulful way to generate docs for Swift. ' \
+  spec.summary       = 'Soulful docs for Swift & Objective-C.'
+  spec.description   = 'Soulful docs for Swift & Objective-C. ' \
                        "Run in your Xcode project's root directory for " \
                        'instant HTML docs.'
   spec.homepage      = 'http://github.com/realm/jazzy'

data/lib/jazzy/doc_builder.rb

@@ -121,6 +121,18 @@ module Jazzy
       puts "jam out ♪♫ to your fresh new docs in `#{output_dir}`"
     end
 
+    def self.decl_for_token(token)
+      if token['key.parsed_declaration']
+        token['key.parsed_declaration']
+      elsif token['key.annotated_decl']
+        token['key.annotated_decl'].gsub(/<[^>]+>/, '')
+      elsif token['key.name']
+        token['key.name']
+      else
+        'unknown declaration'
+      end
+    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|
@@ -133,9 +145,7 @@ module Jazzy
         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")
+            f.write("\t" + decl_for_token(token) + "\n")
           end
         end
       end

data/lib/jazzy/gem_version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-23 00:00:00.000000000 Z
+date: 2014-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
@@ -138,8 +138,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
-description: A soulful way to generate docs for Swift. Run in your Xcode project's
-  root directory for instant HTML docs.
+description: Soulful docs for Swift & Objective-C. Run in your Xcode project's root
+  directory for instant HTML docs.
 email:
 - jp@realm.io
 executables:
@@ -151,6 +151,7 @@ files:
 - ".gitmodules"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -335,5 +336,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A soulful way to generate docs for Swift.
+summary: Soulful docs for Swift & Objective-C.
 test_files: []