jazzy: Jazzy 0.7.2 crashes with "comparison of Array with Array failed" ArgumentError

Hello,

I recently updated to Jazzy 0.7.2 and have tried using it to generate documentation for an Xcode 8 project containing Swift 2.3 code. All 578 source files in our project are parsed, but when Jazzy gets to the “building site” stage, Jazzy exits with code 1 and logs:

/Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.2/lib/jazzy/doc_builder.rb:35:in `sort_by': comparison of Array with Array failed (ArgumentError)
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.2/lib/jazzy/doc_builder.rb:35:in `block in doc_structure_for_docs'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.2/lib/jazzy/doc_builder.rb:33:in `map'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.2/lib/jazzy/doc_builder.rb:33:in `doc_structure_for_docs'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.2/lib/jazzy/doc_builder.rb:112:in `build_site'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.2/lib/jazzy/doc_builder.rb:151:in `build_docs_for_sourcekitten_output'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.2/lib/jazzy/doc_builder.rb:75:in `build'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.2/bin/jazzy:15:in `<top (required)>'
    from /usr/local/bin/jazzy:23:in `load'
    from /usr/local/bin/jazzy:23:in `<main>'
error: /usr/local/bin/jazzy failed with an exit code of 1; check any output above for additional details.

Prior to that, I get some USR warnings, eg.:

A compile error prevented CheckoutCountryViewModel.country from receiving a unique USR. Documentation may be incomplete. Please check for compile errors by running `xcodebuild `.

`viewControllerForRouter(router:destination:)` has no USR. First make sure all modules used in your project have been imported. If all used modules are imported, please report this problem by filing an issue at https://github.com/realm/jazzy/issues along with your Xcode project. If this token is declared in an `#if` block, please ignore this message.

Unfortunately, this is a closed-source project so I can’t share the code publicly. But if there is anything I can do to help diagnose the issue further, please let me know.

Thanks! E.

About this issue

Original URL
State: closed
Created 8 years ago
Reactions: 1
Comments: 16 (1 by maintainers)

Commits related to this issue

fix crash when sorting declarations with no USR since usr isn't present in all declarations, we need to fall back on something. fixes #661. — committed to realm/jazzy by jpsim 8 years ago

Most upvoted comments

Fixed.

jpsim on Nov 26, 2016

That was quick, great job @jpsim!!

Any idea when this is going to be released? I assume @orta only uses released versions of Jazzy, and I’d love the docs for my pod to work again… 😃

svdo on Nov 27, 2016

The consequence of this bug are serious: some CocoaPods just don’t have any online reference documentation anymore. No reference, and broken links from other documentation resources.

groue on Nov 26, 2016

Same here:

comparison of Array with Array failed
/Users/cocoadocs/.rvm/gems/ruby-2.1.3/bundler/gems/Jazzy-7242435d5756/lib/jazzy/doc_builder.rb:35:in `sort_by'
/Users/cocoadocs/.rvm/gems/ruby-2.1.3/bundler/gems/Jazzy-7242435d5756/lib/jazzy/doc_builder.rb:35:in `block in doc_structure_for_docs'
/Users/cocoadocs/.rvm/gems/ruby-2.1.3/bundler/gems/Jazzy-7242435d5756/lib/jazzy/doc_builder.rb:33:in `map'
/Users/cocoadocs/.rvm/gems/ruby-2.1.3/bundler/gems/Jazzy-7242435d5756/lib/jazzy/doc_builder.rb:33:in `doc_structure_for_docs'
/Users/cocoadocs/.rvm/gems/ruby-2.1.3/bundler/gems/Jazzy-7242435d5756/lib/jazzy/doc_builder.rb:113:in `build_site'
/Users/cocoadocs/.rvm/gems/ruby-2.1.3/bundler/gems/Jazzy-7242435d5756/lib/jazzy/doc_builder.rb:152:in `build_docs_for_sourcekitten_output'
/Users/cocoadocs/.rvm/gems/ruby-2.1.3/bundler/gems/Jazzy-7242435d5756/lib/jazzy/doc_builder.rb:76:in `build'
/Users/cocoadocs/cocoadocs.org/./cocoadocs.rb:443:in `document_spec'
/Users/cocoadocs/cocoadocs.org/./cocoadocs.rb:532:in `document_spec_at_path'
/Users/cocoadocs/cocoadocs.org/./cocoadocs.rb:152:in `block in doc'
/Users/cocoadocs/cocoadocs.org/./cocoadocs.rb:147:in `each'
/Users/cocoadocs/cocoadocs.org/./cocoadocs.rb:147:in `doc'
/Users/cocoadocs/cocoadocs.org/./cocoadocs.rb:219:in `block in cocoadocs_url'
/Users/cocoadocs/.rvm/rubies/ruby-2.1.3/lib/ruby/2.1.0/open-uri.rb:153:in `open_uri'
/Users/cocoadocs/.rvm/rubies/ruby-2.1.3/lib/ruby/2.1.0/open-uri.rb:704:in `open'
/Users/cocoadocs/.rvm/rubies/ruby-2.1.3/lib/ruby/2.1.0/open-uri.rb:34:in `open'
/Users/cocoadocs/cocoadocs.org/./cocoadocs.rb:216:in `cocoadocs_url'
/Users/cocoadocs/cocoadocs.org/./cocoadocs.rb:167:in `cocoadocs'
/Users/cocoadocs/cocoadocs.org/./cocoadocs.rb:102:in `initialize'
/Users/cocoadocs/cocoadocs.org/./cocoadocs.rb:564:in `new'
/Users/cocoadocs/cocoadocs.org/./cocoadocs.rb:564:in `<main>'

(output from http://api.cocoadocs.org:4567/error/GRDB.swift/0.90.1)

groue on Nov 26, 2016

Yes, I can reproduce the problem in this project: https://github.com/kareman/SwiftShell. This code has several #if blocks. I get the following error message:

Running xcodebuild
Parsing Bash.swift (1/9)
Parsing Command.swift (2/9)
Parsing Context.swift (3/9)
Parsing String.swift (4/9)
Parsing FileHandle.swift (5/9)
Parsing Files.swift (6/9)
Parsing Stream.swift (7/9)
Parsing Array.swift (8/9)
Parsing Lazy-split.swift (9/9)
`nullDev` has no USR. First make sure all modules used in your project have been imported. If all used modules are imported, please report this problem by filing an issue at https://github.com/realm/jazzy/issues along with your Xcode project. If this token is declared in an `#if` block, please ignore this message.
building site
doc_builder.rb:35: in `sort_by': comparison of Array with Array failed (ArgumentError)
	from /usr/local/lib/ruby/gems/2.3.0/gems/jazzy-0.7.2/lib/jazzy/doc_builder.rb:35:in `block in doc_structure_for_docs'
	from /usr/local/lib/ruby/gems/2.3.0/gems/jazzy-0.7.2/lib/jazzy/doc_builder.rb:33:in `map'
	from /usr/local/lib/ruby/gems/2.3.0/gems/jazzy-0.7.2/lib/jazzy/doc_builder.rb:33:in `doc_structure_for_docs'
	from /usr/local/lib/ruby/gems/2.3.0/gems/jazzy-0.7.2/lib/jazzy/doc_builder.rb:112:in `build_site'
	from /usr/local/lib/ruby/gems/2.3.0/gems/jazzy-0.7.2/lib/jazzy/doc_builder.rb:151:in `build_docs_for_sourcekitten_output'
	from /usr/local/lib/ruby/gems/2.3.0/gems/jazzy-0.7.2/lib/jazzy/doc_builder.rb:75:in `build'
	from /usr/local/lib/ruby/gems/2.3.0/gems/jazzy-0.7.2/bin/jazzy:15:in `<top (required)>'
	from /usr/local/bin/jazzy:23:in `load'
	from /usr/local/bin/jazzy:23:in `<main>'

kareman on Nov 23, 2016