RDoc 4.0.1

drbrain | Wed, 27 Mar 2013 22:49:00 GMT

  • home: https://github.com/rdoc/rdoc
  • rdoc: http://docs.seattlerb.org/rdoc
  • bugs: https://github.com/rdoc/rdoc/issues

RDoc produces HTML and command-line documentation for Ruby projects. RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentation from the command-line.

Changes:

  • Bug fixes
    • RDoc::Options parser should rescue from OptionParser::ParseError.
    • Updated example of RDoc::Options to include reopening RDoc::Options. Pointed out by Michael Granger
    • Moved RubyGems documentation installed message into RDoc hook. For RubyGems bug #469 by Jeff Sandberg
    • An Error is now raised when a heredoc is not terminated. Fixes exceptions when processing comment blocks. Reported by darix
    • rdoc --quiet --no-ignore-invalid now exits for invalid options. Pull request #192 by Jeremy Evans
    • RDoc::Parser::C no longer ignores a (METHOD) cast in rbdefinemethod. Pull request #184 by Carlos Agarie
    • RDoc::Servlet no longer ignores extra directories from -d. Pull request #173 by Thomas Leitner
    • Fixed rdoc --ri-site. Bug #193 by Michal Papis.
    • RDoc no longer attempts to parse binary files. Bug #189 by postmodern, Bug #190 by Christoffer Lervåg, Bug #195 by Aaron Patterson
    • rdoc --pipe output now contains for markdown compliance.
    • RDoc no longer leaves emacs-style modelines in .txt, .md or .rd files. Bug #178 by Zachary Scott
    • RDoc no longer puts raw markup in HTML output for markdown input. Bug #204 by Erik Hollensbe
    • Code objects with nodoc are no longer included in the ri store. Bug #177 by Thomas Leitner.
    • Text#snippet now creates a RDoc::Markup::ToHtmlSnippet correctly.
    • The C parser now de-duplicates call-seq if the same C function is used for multiple method names. Bug #203 by Pete Higgins

Posted in ,  | 1016 comments | no trackbacks

rdoc 4.0.0

drbrain | Sun, 24 Feb 2013 17:31:00 GMT

RDoc produces HTML and command-line documentation for Ruby projects. RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentation from the command-line.

Changes

RDoc 4.0 includes several new features and several breaking changes. The changes should not affect users of rdoc or ri.

Notable feature additions are markdown support and an WEBrick servlet that can serve HTML from an ri store. (This means that RubyGems 2.0+ no longer needs to build HTML documentation when installing gems.)

Changes since RDoc 3.12.1:

  • Breaking changes

    • The default output encoding for RDoc is now UTF-8. Previously RDoc used the default external encoding which was determined from your locale. Issue #106 by Justin Baker.

    • RDoc::RI::Store is now RDoc::Store so ri data generated by RDoc 4 cannot be read by earlier versions of RDoc. RDoc::RI::Store exists as an alias of RDoc::Store so ri data from older versions can still be read. RDoc::RI::Store will be removed in RDoc 5.

      Tests that create RDoc::CodeObjects on the fly without wiring them into the documentation tree (did not use add_class, add_method, etc.) must be updated to use these methods. The documentation tree automatically attaches them to the store instance which allows lookups to work correctly. Additionally, a new method RDoc::Store#add_file must be used instead of RDoc::TopLevel.new. The latter will not be attached to the documentation tree.

    • RDoc generators must accept an RDoc::Store and an RDoc::Options in initialize. RDoc no longer passes an Array of RDoc::TopLevel objects to #generate. Use RDoc::Store#all_files instead.
    • Some markup formatters (RDoc::Markup::To*) now accept an RDoc::Options instance as the first argument. Notably, the base class Formatter and ToHtml*. (This is not universal due to the difficult at accessing the user's options instance deep inside RDoc. A future major release may remedy this.)
    • Added new markup nodes and specials that RDoc::Markup::Formatter subclasses must handle. If you're using RDoc::Markup::FormatterTestCase the new methods you need to add should be readily apparent.
    • Removed RDoc::RI::Paths::SYSDIR and ::SITEDIR. These were hidden constants so no breakage is expected. Use RDoc::RI::Paths::systemdir and ::sitedir instead.
    • RDoc::RI::Store#modules has been renamed to RDoc::Store#module_names to avoid confusion with RDoc::Store#all_modules imported from RDoc::TopLevel.
    • RDoc::RDocError has been removed. It was deprecated throughout RDoc 3.
    • ri -f html is no longer supported.
    • Comment definitions in C comments are now only discovered from the first line. A colon on a subsequent line won't trigger definition extraction. Issue #103, see also http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-core/42942
    • Fixed :stopdoc: for class A::B where A has not been seen. Issue #95 by Ryan Davis
    • RDoc::ClassModule#each_ancestor no longer yields itself if there is circular ancestry

  • Major enhancements

    • ri can now show pages (README, etc.)

      ri rdoc:README

      Will show the README for the latest version of RDoc. You can specify exact gem versions such as "rdoc-4.0:README" or view pages from the standard library documentation with "ruby:README".

      RDoc 3 did not save pages in ri data so you will need to regenerate documentation from your gems to use this feature.

    • Added Markdown as a supported format. The markdown format can be set on a per-file or per-comment basis with the +:markdown:+ directive like the rd and tomdoc formats and on a per-project basis with rdoc --markup markdown --write-options

    • Removed global state from RDoc. RDoc::Store holds the documentation tree and connects the driver to the parsers and generator. This also allows documentation parsing and generation for multiple instances, but the rdoc command-line tool does not support this.

      Due to this change RDoc::RDoc.current and RDoc::RDoc.reset no longer exist.

  • Minor enhancements

    • Added --page-dir option to give pretty names for a FAQ, guides, or other documentation you write that is not stored in the project root. For example, with the following layout:

      README.txt guides/syntax.txt guides/conversion.txt

      Running rdoc --page-dir guides will make the files in "guides" appear to be at the top level of the project. This means they will appear to exist at the top level in HTML output and you can access them with ri your\_gem:syntax and ri your\_gem:conversion.

    • Added --root for building documentation from outside the source dir.
    • Added current heading and page-top links to HTML headings.
    • Added a ChangeLog parser. It automatically parses files that begin with 'ChangeLog'
    • Added a table of contents to the sidebar.
    • RDoc markup format merges adjacent labels in a label or note list into a single definition list item for output.
    • RDoc now tracks use of extend. Pull request #118 by Michael Granger.
    • RDoc now tracks methods that use super. Pull request #116 by Erik Hollensbe.
    • Added methods ::systemdir, ::sitedir, ::home_dir and ::gem_dir to fetch the components of RDoc::RI::Paths.path individually.
    • Added support for rb_file_const.
    • RDoc now processes files in sorted order. Issue #71 by Vít Ondruch
    • RDoc now warns with --verbose when methods are duplicated. Issue #71 by Vít Ondruch
    • ri will display documentation for all methods in a class if -a is given. Issue #57 by casper
    • The RDoc coverage report will report line information for attributes, constants and methods missing documentation. Issue #121 by Zachary Scott
    • RDoc now reports a warning for files that are unreadable due to permissions problems.
    • RDoc controls documentation generation for RubyGems 2.0+

  • Bug fixes

    • Fixed parsing of multibyte files with incomplete characters at byte 1024. Ruby bug #6393 by nobu, patch by Nobuyoshi Nakada and Yui NARUSE.
    • Fixed rdoc -E. Ruby Bug #6392 and (modified) patch by Nobuyoshi Nakada
    • Added link handling to Markdown output. Bug #160 by burningTyger.
    • Fixed HEREDOC output for the limited case of a heredoc followed by a line end. When a HEREDOC is not followed by a line end RDoc is not currently smart enough to restore the source correctly. Bug #162 by Zachary Scott.
    • Fixed parsing of executables with shebang and encoding comments. Bug #161 by Marcus Stollsteimer
    • RDoc now ignores methods defined on constants instead of creating a fake module. Bug #163 by Zachary Scott.
    • Fixed ChangeLog parsing for FFI gem. Bug #165 by Zachary Scott.
    • RDoc now links #=== methods. Bug #164 by Zachary Scott.
    • Allow [] following argument names for TomDoc. Bug #167 by Ellis Berner.
    • Fixed the RDoc servlet for home and site directories. Bug #170 by Thomas Leitner.
    • Fixed references to methods in the RDoc servlet. Bug #171 by Thomas Leitner.
    • Fixed debug message when generating the darkfish root page. Pull Request #174 by Thomas Leitner.
    • Fixed deletion of attribute ri data when a class was loaded then saved. Issue #171 by Thomas Leitner.
    • Fully qualified names for constants declared from the top level are now attached to their class or module properly.
    • Fixed table of contents display in HTML output for classes and modules.
    • Incremental ri builds of C files now work. C variable names from previous runs are now saved between runs.
    • A word that is directly followed by a multi-word tidy link label no longer disappears. (Like text{link}[http://example])
    • Fixed legacy template support. Pull Request #107 by Justin Baker.
    • An HTML class in a verbatim section no longer triggers ruby parsing. Issue #92 by Vijay Dev
    • Improved documentation for setting the default documentation format for your ruby project. Issue #94 by Henrik Hodne
    • Fixed handling of LANG in the RDoc::Options tests. Issue #99 by Vít Ondruch
    • RDoc no longer quits when given an entry that is not a file or directory. Issue #101 by Charles Nutter
    • Fixed bug in syntax-highlighting that would corrupt regular expressions. Ruby Bug #6488 by Benny Lyne Amorsen.
    • "class Object" no longer appears in the coverage report if all its methods are documented. This suppresses a false positive for libraries that add toplevel methods. Pull Request #128 by Zachary Scott.
    • Fixed testgenurl test name in TestRDocMarkupToHtml. Pull Request #130 by Zachary Scott.
    • Comment-defined methods ahead of define_method are now discovered. Issue #133 by eclectic923
    • Fixed detection of define_method documentation. Issue #138 by Marvin Gülker.
    • Fixed lexing of character syntax (?z). Reported by Xavier Noria.
    • Add license to gem spec. Issue #144 by pivotalcommon
    • Fixed comment selection for classes. Pull request #146 by pioz
    • Fixed parsing of def self.&() end. Issue #148 by Michael Lucy
    • Generated RD parser files are now included in the gem. Issue #145 by Marvin Gülker
    • Class and module aliases now create new classes to avoid duplicate names in the class list. Issue #143 by Richard Schneeman, Rails Issue #2839
    • RDoc::Markup::Parser now correctly matches indentation of lists when multibyte characters are used in the list labels. Issue #140 by burningTyger
    • Fixed mangling of email addresses that look like labels. Issue #129 by Tobias Koch
    • Classes and modules in a C file may now be created in any order. Issue #124 by Su Zhang
    • A metaprogrammed method supports the :args: directive. Issue #100
    • A metaprogrammed method supports the :yields: directive.
    • RDoc will now look for directives up to the end of the line. For example, class B < A; end # :nodoc: will now hide documentation of B. Issue #125 by Zachary Scott
    • Fixed tokenization of % when it is not followed by a $-string type
    • Fixed display of _END_ in documentation examples in HTML output
    • Fixed tokenization of reserved words used as new-style hash keys
    • RDoc now handles class << $gvar by ignoring the body
    • Fixed parsing of class A:: B.
    • Worked around bug in RDoc::RubyLex where tokens won't be reinterpreted after unget_tk.
    • Fixed class << ::Foo writing documentation to /Foo.html
    • Fixed class ::A referencing itself from inside its own namespace.

Changes since RDoc 4.0.0.rc.2:

  • Bug fix
    • Templates now use the correct encoding when generating pages. Issue #183 by Vít Ondruch

Posted in ,  | 2 comments | no trackbacks

RDoc 4.0.0.rc.2.1

drbrain | Fri, 08 Feb 2013 22:58:00 GMT

As a preview release, please file bugs for any problems you have with rdoc at https://github.com/rdoc/rdoc/issues

RDoc 4.0 includes several new features and several breaking changes. The changes should not affect users of rdoc or ri.

Notable feature additions are markdown support and an WEBrick servlet that can serve HTML from an ri store. (This means that RubyGems 2.0+ no longer needs to build HTML documentation when installing gems.)

Changes since RDoc 3.12.1:

  • Breaking changes

    • The default output encoding for RDoc is now UTF-8. Previously RDoc used the default external encoding which was determined from your locale. Issue #106 by Justin Baker.

    • RDoc::RI::Store is now RDoc::Store so ri data generated by RDoc 4 cannot be read by earlier versions of RDoc. RDoc::RI::Store exists as an alias of RDoc::Store so ri data from older versions can still be read. RDoc::RI::Store will be removed in RDoc 5.

      Tests that create RDoc::CodeObjects on the fly without wiring them into the documentation tree (did not use addclass, addmethod, etc.) must be updated to use these methods. The documentation tree automatically attaches them to the store instance which allows lookups to work correctly. Additionally, a new method RDoc::Store#add_file must be used instead of RDoc::TopLevel.new. The latter will not be attached to the documentation tree.

    • RDoc generators must accept an RDoc::Store and an RDoc::Options in initialize. RDoc no longer passes an Array of RDoc::TopLevel objects to #generate. Use RDoc::Store#all_files instead.
    • Some markup formatters (RDoc::Markup::To) now accept an RDoc::Options instance as the first argument. Notably, the base class Formatter and ToHtml. (This is not universal due to the difficult at accessing the user's options instance deep inside RDoc. A future major release may remedy this.)
    • Added new markup nodes and specials that RDoc::Markup::Formatter subclasses must handle. If you're using RDoc::Markup::FormatterTestCase the new methods you need to add should be readily apparent.
    • Removed RDoc::RI::Paths::SYSDIR and ::SITEDIR. These were hidden constants so no breakage is expected. Use RDoc::RI::Paths::systemdir and ::sitedir instead.
    • RDoc::RI::Store#modules has been renamed to RDoc::Store#modulenames to avoid confusion with RDoc::Store#allmodules imported from RDoc::TopLevel.
    • RDoc::RDocError has been removed. It was deprecated throughout RDoc 3.
    • ri -f html is no longer supported.
    • Comment definitions in C comments are now only discovered from the first line. A colon on a subsequent line won't trigger definition extraction. Issue #103, see also http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-core/42942
    • Fixed :stopdoc: for class A::B where A has not been seen. Issue #95 by Ryan Davis
    • RDoc::ClassModule#each_ancestor no longer yields itself if there is circular ancestry

  • Major enhancements

    • ri can now show pages (README, etc.)

      ri rdoc:README

      Will show the README for the latest version of RDoc. You can specify exact gem versions such as "rdoc-4.0:README" or view pages from the standard library documentation with "ruby:README".

      RDoc 3 did not save pages in ri data so you will need to regenerate documentation from your gems to use this feature.

    • Added Markdown as a supported format. The markdown format can be set on a per-file or per-comment basis with the +:markdown:+ directive like the rd and tomdoc formats and on a per-project basis with rdoc --markup markdown --write-options

    • Removed global state from RDoc. RDoc::Store holds the documentation tree and connects the driver to the parsers and generator. This also allows documentation parsing and generation for multiple instances, but the rdoc command-line tool does not support this.

      Due to this change RDoc::RDoc.current and RDoc::RDoc.reset no longer exist.

  • Minor enhancements

    • Added --page-dir option to give pretty names for a FAQ, guides, or other documentation you write that is not stored in the project root. For example, with the following layout:

      README.txt guides/syntax.txt guides/conversion.txt

      Running rdoc --page-dir guides will make the files in "guides" appear to be at the top level of the project. This means they will appear to exist at the top level in HTML output and you can access them with ri your_gem:syntax and ri your_gem:conversion.

    • Added --root for building documentation from outside the source dir.
    • Added current heading and page-top links to HTML headings.
    • Added a ChangeLog parser. It automatically parses files that begin with 'ChangeLog'
    • Added a table of contents to the sidebar.
    • RDoc markup format merges adjacent labels in a label or note list into a single definition list item for output.
    • RDoc now tracks use of extend. Pull request #118 by Michael Granger.
    • RDoc now tracks methods that use super. Pull request #116 by Erik Hollensbe.
    • Added methods ::systemdir, ::sitedir, ::homedir and ::gemdir to fetch the components of RDoc::RI::Paths.path individually.
    • Added support for rbfileconst.
    • RDoc now processes files in sorted order. Issue #71 by Vít Ondruch
    • RDoc now warns with --verbose when methods are duplicated. Issue #71 by Vít Ondruch
    • ri will display documentation for all methods in a class if -a is given. Issue #57 by casper
    • The RDoc coverage report will report line information for attributes, constants and methods missing documentation. Issue #121 by Zachary Scott
    • RDoc now reports a warning for files that are unreadable due to permissions problems.
    • RDoc controls documentation generation for RubyGems 2.0+

  • Bug fixes

    • Fixed parsing of multibyte files with incomplete characters at byte 1024. Ruby bug #6393 by nobu, patch by Nobuyoshi Nakada and Yui NARUSE.
    • Fixed rdoc -E. Ruby Bug #6392 and (modified) patch by Nobuyoshi Nakada
    • Added link handling to Markdown output. Bug #160 by burningTyger.
    • Fixed HEREDOC output for the limited case of a heredoc followed by a line end. When a HEREDOC is not followed by a line end RDoc is not currently smart enough to restore the source correctly. Bug #162 by Zachary Scott.
    • Fixed parsing of executables with shebang and encoding comments. Bug #161 by Marcus Stollsteimer
    • RDoc now ignores methods defined on constants instead of creating a fake module. Bug #163 by Zachary Scott.
    • Fixed ChangeLog parsing for FFI gem. Bug #165 by Zachary Scott.
    • RDoc now links #=== methods. Bug #164 by Zachary Scott.
    • Allow [] following argument names for TomDoc. Bug #167 by Ellis Berner.
    • Fixed the RDoc servlet for home and site directories. Bug #170 by Thomas Leitner.
    • Fixed references to methods in the RDoc servlet. Bug #171 by Thomas Leitner.
    • Fixed debug message when generating the darkfish root page. Pull Request #174 by Thomas Leitner.
    • Fixed deletion of attribute ri data when a class was loaded then saved. Issue #171 by Thomas Leitner.
    • Fully qualified names for constants declared from the top level are now attached to their class or module properly.
    • Fixed table of contents display in HTML output for classes and modules.
    • Incremental ri builds of C files now work. C variable names from previous runs are now saved between runs.
    • A word that is directly followed by a multi-word tidy link label no longer disappears. (Like text{link}[http://example])
    • Fixed legacy template support. Pull Request #107 by Justin Baker.
    • An HTML class in a verbatim section no longer triggers ruby parsing. Issue #92 by Vijay Dev
    • Improved documentation for setting the default documentation format for your ruby project. Issue #94 by Henrik Hodne
    • Fixed handling of LANG in the RDoc::Options tests. Issue #99 by Vít Ondruch
    • RDoc no longer quits when given an entry that is not a file or directory. Issue #101 by Charles Nutter
    • Fixed bug in syntax-highlighting that would corrupt regular expressions. Ruby Bug #6488 by Benny Lyne Amorsen.
    • "class Object" no longer appears in the coverage report if all its methods are documented. This suppresses a false positive for libraries that add toplevel methods. Pull Request #128 by Zachary Scott.
    • Fixed testgenurl test name in TestRDocMarkupToHtml. Pull Request #130 by Zachary Scott.
    • Comment-defined methods ahead of define_method are now discovered. Issue #133 by eclectic923
    • Fixed detection of define_method documentation. Issue #138 by Marvin Gülker.
    • Fixed lexing of character syntax (?z). Reported by Xavier Noria.
    • Add license to gem spec. Issue #144 by pivotalcommon
    • Fixed comment selection for classes. Pull request #146 by pioz
    • Fixed parsing of def self.&() end. Issue #148 by Michael Lucy
    • Generated RD parser files are now included in the gem. Issue #145 by Marvin Gülker
    • Class and module aliases now create new classes to avoid duplicate names in the class list. Issue #143 by Richard Schneeman, Rails Issue #2839
    • RDoc::Markup::Parser now correctly matches indentation of lists when multibyte characters are used in the list labels. Issue #140 by burningTyger
    • Fixed mangling of email addresses that look like labels. Issue #129 by Tobias Koch
    • Classes and modules in a C file may now be created in any order. Issue #124 by Su Zhang
    • A metaprogrammed method supports the :args: directive. Issue #100
    • A metaprogrammed method supports the :yields: directive.
    • RDoc will now look for directives up to the end of the line. For example, class B < A; end # :nodoc: will now hide documentation of B. Issue #125 by Zachary Scott
    • Fixed tokenization of % when it is not followed by a $-string type
    • Fixed display of END in documentation examples in HTML output
    • Fixed tokenization of reserved words used as new-style hash keys
    • RDoc now handles class << $gvar by ignoring the body
    • Fixed parsing of class A:: B.
    • Worked around bug in RDoc::RubyLex where tokens won't be reinterpreted after unget_tk.
    • Fixed class << ::Foo writing documentation to /Foo.html
    • Fixed class ::A referencing itself from inside its own namespace.

Changes since RDoc 4.0.0.rc.2:

  • Bug fix
    • Templates now use the correct encoding when generating pages. Issue #183 by Vít Ondruch

Posted in ,  | no comments | no trackbacks

RDoc XSS vulnerability CVE-2013-0256 releases 3.9.5, 3.12.1, 4.0.0.rc.2

drbrain | Wed, 06 Feb 2013 18:35:00 GMT

RDoc versions 3.9.5, 3.12.1 and 4.0.0.rc.2 have been released!

RDoc produces HTML and command-line documentation for Ruby projects. RDoc includes the rdoc and ri tools for generating and displaying documentation from the command-line.

Vulnerability Description

RDoc documentation generated by rdoc 2.3.0 through rdoc 3.12 and prereleases up to rdoc 4.0.0.preview2.1 are vulnerable to an XSS exploit. This exploit may lead to cookie disclosure to third parties.

The exploit exists in darkfish.js which is copied from the RDoc install location to the generated documentation.

RDoc is a static documentation generation tool. Patching the library itself is insufficient to correct this exploit. Those hosting rdoc documentation will need to apply the following patch. If applied while ignoring whitespace, this patch will correct all affected versions:

diff --git darkfish.js darkfish.js
index 4be722f..f26fd45 100644
--- darkfish.js
+++ darkfish.js
@@ -109,13 +109,15 @@ function hookSearch() {
 function highlightTarget( anchor ) {
   console.debug( "Highlighting target '%s'.", anchor );

-  $("a[name=" + anchor + "]").each( function() {
-    if ( !$(this).parent().parent().hasClass('target-section') ) {
-      console.debug( "Wrapping the target-section" );
-      $('div.method-detail').unwrap( 'div.target-section' );
-      $(this).parent().wrap( '<div class="target-section"></div>' );
-    } else {
-      console.debug( "Already wrapped." );
+  $("a[name]").each( function() {
+    if ( $(this).attr("name") == anchor ) {
+      if ( !$(this).parent().parent().hasClass('target-section') ) {
+        console.debug( "Wrapping the target-section" );
+        $('div.method-detail').unwrap( 'div.target-section' );
+        $(this).parent().wrap( '<div class="target-section"></div>' );
+      } else {
+        console.debug( "Already wrapped." );
+      }
     }
   });
 };

RDoc 3.9.5, 3.12.1 and RDoc 4.0.0.rc.2 and newer are not vulnerable to this exploit.

This exploit was discovered by Evgeny Ermakov corwmh@gmail.com.

This vulnerability has been assigned the CVE identifier CVE-2013-0256.

RDoc 3.9.5

RDoc 3.9.5 was released to match the RDoc in ruby 1.9.3-p385.

  • Bug fixes
    • Fixed an XSS exploit in darkfish.js. This could lead to cookie disclosure to third parties. See CVE-2013-0256.rdoc for full details including a patch you can apply to generated RDoc documentation.

RDoc 3.12.1

RDoc 3.12.1 was updated as the latest stable release as RDoc 4 is not yet ready.

  • Bug fixes
    • Fixed an XSS exploit in darkfish.js. This could lead to cookie disclosure to third parties. See CVE-2013-0256.rdoc for full details including a patch you can apply to generated RDoc documentation.
    • Ensured that rd parser files are generated before checking the manifest.

RDoc 4.0.0.rc.2

  • Minor enhancements

    • Added current heading and page-top links to HTML headings.

  • Bug fixes

    • Fixed an XSS exploit in darkfish.js. This could lead to cookie disclosure to third parties. See CVE-2013-0256.rdoc for full details including a patch you can apply to generated RDoc documentation.
    • Fixed parsing of multibyte files with incomplete characters at byte 1024. Ruby bug #6393 by nobu, patch by Nobuyoshi Nakada and Yui NARUSE.
    • Fixed rdoc -E. Ruby Bug #6392 and (modified) patch by Nobuyoshi Nakada
    • Added link handling to Markdown output. Bug #160 by burningTyger.
    • Fixed HEREDOC output for the limited case of a heredoc followed by a line end. When a HEREDOC is not followed by a line end RDoc is not currently smart enough to restore the source correctly. Bug #162 by Zachary Scott.
    • Fixed parsing of executables with shebang and encoding comments. Bug #161 by Marcus Stollsteimer
    • RDoc now ignores methods defined on constants instead of creating a fake module. Bug #163 by Zachary Scott.
    • Fixed ChangeLog parsing for FFI gem. Bug #165 by Zachary Scott.
    • RDoc now links #=== methods. Bug #164 by Zachary Scott.
    • Allow [] following argument names for TomDoc. Bug #167 by Ellis Berner.
    • Fixed the RDoc servlet for home and site directories. Bug #170 by Thomas Leitner.
    • Fixed references to methods in the RDoc servlet. Bug #171 by Thomas Leitner.
    • Fixed debug message when generating the darkfish root page. Pull Request #174 by Thomas Leitner.
    • Fixed deletion of attribute ri data when a class was loaded then saved. Issue #171 by Thomas Leitner.

Posted in ,  | no comments | no trackbacks

Mechanize 2.5

drbrain | Wed, 09 May 2012 20:48:00 GMT

The Mechanize library is used for automating interaction with websites. Mechanize automatically stores and sends cookies, follows redirects, and can follow links and submit forms. Form fields can be populated and submitted. Mechanize also keeps track of the sites that you have visited as a history.

Changes

  • Minor enhancement

    • Added Mechanize#ignore_bad_chunking for working around servers that don’t terminate chunked transfer-encoding properly. Enabling this may cause data loss. Issue #116

    • Removed content-type check from Mechanize::Page allowing forced parsing of incorrect or missing content-types. Issue #221 by GarthSnyder

  • Bug fixes

    • Fixed typos in EXAMPLES and GUIDES. Pull Request #213 by Erkan Yilmaz.

    • Fixed handling of a quoted content-disposition size. Pull Request #220 by Jason Rust

    • Mechanize now ignores a missing gzip footer like browsers do. Issue #224 by afhbl

    • Mechanize handles saving of files with the same name better now. Pull Request #223 by Godfrey Chan, Issue #219 by Jon Hart

    • Mechanize now sends headers across redirects. Issue #215 by Chris Gahan

    • Mechanize now raises Mechanize::ResponseReadError when the server does not terminate chunked transfer-encoding properly. Issue #116

    • Mechanize no longer raises an exception when multiple identical radiobuttons are checked. Issue #214 by Matthias Guenther

    • Fixed documentation for pre_connect_hooks and post_connect_hooks. Issue #226 by Robert Poor

    • Worked around ruby 1.8 run with -Ku and ISO-8859-1 encoded characters in URIs. Issue #228 by Stanislav O.Pogrebnyak

Posted in  | no comments | no trackbacks

Mechanize 2.4 Security Fix

drbrain | Sat, 21 Apr 2012 00:53:57 GMT

The Mechanize library is used for automating interaction with websites. Mechanize automatically stores and sends cookies, follows redirects, and can follow links and submit forms. Form fields can be populated and submitted. Mechanize also keeps track of the sites that you have visited as a history.

Changes

  • Security fix:

    Mechanize#auth and Mechanize#basic_auth allowed disclosure of passwords to malicious servers and have been deprecated.

    In prior versions of mechanize only one set of HTTP authentication credentials were allowed for all connections. If a mechanize instance connected to more than one server then a malicious server detecting mechanize could ask for HTTP Basic authentication. This would expose the username and password intended only for one server.

    Mechanize#auth and Mechanize#basic_auth now warn when used.

    To fix the warning switch to Mechanize#add_auth which requires the URI the credentials are intended for, the username and the password. Optionally an HTTP authentication realm or NTLM domain may be provided.

  • Minor enhancement

    • Improved exception messages for 401 Unauthorized responses. Mechanize now tells you if you were missing credentials, had an incorrect password, etc.

Posted in  | no comments | no trackbacks

rdoc-spellcheck 1.0

drbrain | Mon, 09 Apr 2012 23:34:30 GMT

rdoc-spellcheck checks your documentation for spelling errors. File, class, and method names are automatically excluded from the results and you can add your own words to the default word list.

Features

  • Checks documentation for pages, classes, modules, methods, constants, etc.

  • Prints a report showing each misspelled word and correction suggestions

Synopsis

$ rdoc -f spellcheck lib *.rdoc

Requirements

Install

sudo gem install rdoc-spellcheck

Posted in ,  | no comments | no trackbacks

ruby-growl 4.0

drbrain | Thu, 05 Apr 2012 00:36:32 GMT

ruby-growl version 4.0 has been released!

A pure-ruby growl notifier for UDP and GNTP growl protocols. ruby-growl allows you to perform Growl notifications from machines without growl installed (for example, non-OSX machines).

What is growl? Growl is a really cool “global notification system originally for Mac OS X”.

You can receive Growl notifications on various platforms and send them from any machine that runs Ruby.

OS X: growl.info Windows: www.growlforwindows.com/gfw/ Linux: github.com/mattn/growl-for-linux

ruby-growl also contains a command-line notification tool named ‘growl’. It is almost completely option-compatible with growlnotify. (All except for -p is supported, use –priority instead.)

Changes:

  • API changes:

    • Growl is now a wrapper for Growl::UDP (1.2 and older) and Growl::GNTP (1.3 and newer). The main difference is that notifications need to be registered with Growl#add_notification instead of via Growl#initialize.

    • Ruby 1.9.2 or newer is required to use ruby-growl

  • Major enhancements

    • Added GNTP protocol support for registration and notification including application and notification icons and callbacks.

    • Moved UDP protocol support to Growl::UDP

    • Growl automatically determines if the growl server supports GNTP or UDP and uses the best protocol.

Posted in  | no comments | no trackbacks

return_bang 1.1

drbrain | Sun, 01 Apr 2012 20:10:28 GMT

home

github.com/drbrain/return_bang

rdoc

docs.seattlerb.org/return_bang

bugs

github.com/drbrain/return_bang/issues

return_bang implements non-local exits for methods. As a bonus, you also get exception handling that ignores standard Ruby’s inflexible begin; rescue; ensure; end syntax.

Use return_bang to exit back to a processing loop from deeply nested code, or just to confound your enemies and your friends! What could possibly go wrong?

1.1 / 2012-04-01

  • Minor enhancements

    • Added raise! to raise exceptions

    • Added rescue! to rescue exceptions raised

    • Added ensure! to always execute a block of code to perform cleanup

Posted in  | no comments | no trackbacks

net-http-persistent 2.6

drbrain | Mon, 26 Mar 2012 22:17:50 GMT

Manages persistent connections using Net::HTTP plus a speed fix for Ruby 1.8. It’s thread-safe too!

Using persistent HTTP connections can dramatically increase the speed of HTTP. Creating a new HTTP connection for every request involves an extra TCP round-trip and causes TCP congestion avoidance negotiation to start over.

Net::HTTP supports persistent connections with some API methods but does not handle reconnection gracefully. Net::HTTP::Persistent supports reconnection and retry according to RFC 2616.

Changes:

  • Minor enhancement

    • Net::HTTP::Persistent#idle_timeout may be set to nil to disable expiration of connections. Pull Request #21 by Aaron Stone

Posted in  | no comments | no trackbacks