3.2.13.rc1 documentation parse nits

[fburleigh]

On OS X with Ruby 2.0 and RubyGems 2.02, I see four complaints when I install Rails 3.2.13.rc1. A newbie to Ruby like me wouldn't know if any are significant, causing lurking issues while learning. So, I list them here:

• Parsing documentation for activesupport-3.2.13.rc1
  unable to convert "\x80" from ASCII-8BIT to UTF-8 for lib/active_support/values/unicode_tables.dat, skipping
• Parsing documentation for builder-3.0.4
  ruby-2.0.0-p0/lib/ruby/2.0.0/rdoc/parser.rb:87: warning: Unsupported encoding : ignored
  ruby-2.0.0-p0/lib/ruby/2.0.0/rdoc/parser.rb:87: warning: Unsupported encoding ignored
• Parsing documentation for mail-2.5.3
  unable to convert "\x80" from ASCII-8BIT to UTF-8 for lib/mail/values/unicode_tables.dat, skipping

[senny]

mail and builder are dependencies of rails that we don't control ourselves. This leaves us with only the first warning. I think the file that warns should not be parsed by rdoc.

@fxn thoughts?

[carlosantoniodasilva]

The unicode table may need to be updated to fix this, In master it has already been updated in 65bf094.

I think it should be safe to update it in 3-2 as well, what do you think @norman?

[fburleigh]

Sorry fellas, I've reported the mail and builder issues on their respective hubs.

[norman]

@carlosantoniodasilva I don't think it would do any harm at all to update the Unicode tables in Rails 3-2, but I'm not sure this is the root of the issue. I'll look into it a bit right now.

[fburleigh]

Additionally, thinking that gem might update me from rc1 to rc2, I said:

gem update

and got back Rails 4 beta 1 gems, with maybe a hundred "Unable to convert..." complaints while "Parsing documentation for ..." (these all refer to png or jpg images in guides/assets/images). At the end in the terminal I'm left with:

Installing ri documentation for rails-4.0.0.beta1
Installing darkfish documentation for rails-4.0.0.beta1
ERROR:  While executing gem ... (RDoc::Error)
error generating : Error while evaluating ~/.rvm/rubies/ruby-2.0.0-p0/lib/ruby/2.0.0/rdoc/generator/template/darkfish/page.rhtml: undefined method `chomp' for nil:NilClass (RDoc::Error)

I'd guess none of this has to do with Rails per se, but I'm too newbie to do more than share the news.

[norman]

Looks like the same issue reported with RDoc here: ruby/rdoc#190.

It seems RDoc opens unicode_tables.dat to check if it's documentable. Under Ruby 2.0.0 it would be opened as UTF-8 by default, hence the warning when it first hits 0x80, which in UTF-8 must always be preceded by 0xc2 but in unicode_tables.dat is used by itself as a key in the codepoints hash.

Simply excluding .dat files from the RDoc build eliminates the warning - you can reproduce this by checking out the Rails source and running

rdoc activesupport/lib

versus

rdoc --exclude='.dat' activesupport/lib

I'm not sure whether the attempt to process the .dat file and subsequent encoding warning is expected behavior from RDoc, but I don't think it would hurt to add the --exclude option to the various Rails gemspecs.

[carlosantoniodasilva]

Great, thanks for the clarification @norman, we'll be looking into it.

[coolgeng]

I get the same issue when I install coffee-rails gem.

unable to convert "\x80" from ASCII-8BIT to UTF-8 for lib/active_support/values/unicode_tables.dat

[coolgeng]

@norman Fixed this issue by your command. Thanks!

[zzak]

This can be closed, to remove these warnings simply upgrade your rdoc.

Installing gem documentation has nothing to do with rails, and everything to do with rubygems and rdoc. You are free to use a newer version of rdoc and rubygems to install gems and no longer see these errors without rails being effected in any way.

/cc @fxn

[steveklabnik]

I agree. Thanks!

[fxn]

👍

[petershine]

I have executed following command Mac OS X Mountain Lion, according to @norman
rdoc --exclude='.dat' activesupport/lib

After long hours, my start up disk has been reduced its size.
I'm a beginner in gem related stuff, and I just wanted to make it up to date by using
sudo gem update

Faced with issue mentioned in this ticket, I simply tried @norman 's command.
Not knowing what's is the reason for suddenly increased disk space consumption, I need some help to restore my machine to normal state.

Will rdoc clean may solve my problem?