Ruby guidelines for creating libs

[Randy W. Sims]

Does Ruby have something equivelant to Perl's perlmodstyle[1] manual
page? Something that lays out the prefered style and conventions used to
create libraries. Little things like: How do you specify versions? (grep
shows usage of both VERSION and VERSION_MAJOR, VERSION_MINOR, etc.)
Preferred documentation style. Naming. Error handling. Packaging &
configuration. etc.

Thanks,
Randy.

1. <http://perldoc.com/perl5.8.4/pod/perlmodstyle.html>

 

[Mauricio Fernández]

Does Ruby have something equivelant to Perl's perlmodstyle[1] manual
page? Something that lays out the prefered style and conventions used to
create libraries. Little things like: How do you specify versions? (grep
shows usage of both VERSION and VERSION_MAJOR, VERSION_MINOR, etc.)
Preferred documentation style. Naming. Error handling. Packaging &
configuration. etc.

Regarding packaging, take a look at
http://www.rubygarden.org/ruby?QuickGuideToPackaging

 

[Chad Fowler]

Does Ruby have something equivelant to Perl's perlmodstyle[1] manual
page? Something that lays out the prefered style and conventions used to
create libraries. Little things like: How do you specify versions? (grep
shows usage of both VERSION and VERSION_MAJOR, VERSION_MINOR, etc.)
Preferred documentation style. Naming. Error handling. Packaging &
configuration. etc.

Thanks,
Randy.

1. <http://perldoc.com/perl5.8.4/pod/perlmodstyle.html>

More specific than what you're looking for but still relevant, check
out the RubyGems chapter from the upcoming Programming Ruby 2nd
edition[1]. It deals with how to create RubyGem packages out of your
libraries.

Chad

[1] http://www.pragmaticprogrammer.com/titles/ruby/index.html

 

[David Ross]

Here is documentation from experts.

http://www.freebsd.org/doc/en_US.ISO8859-1/books/developers-handbook/policies-shlib.html

its the english page of the developers handbook. This
is what you should follow that is very common and good
to use.

--dross

Does Ruby have something equivelant to Perl's
perlmodstyle[1] manual
page? Something that lays out the prefered style and
conventions used to
create libraries. Little things like: How do you
specify versions? (grep
shows usage of both VERSION and VERSION_MAJOR,
VERSION_MINOR, etc.)
Preferred documentation style. Naming. Error
handling. Packaging &
configuration. etc.

Thanks,
Randy.

1.
<http://perldoc.com/perl5.8.4/pod/perlmodstyle.html>

__________________________________
Do you Yahoo!?
Yahoo! Mail is new and improved - Check it out!
http://promotions.yahoo.com/new_mail

 

[Rob]

RubyGems is a package management framework for Ruby. Packaging your
code as a gem allows others to easily install it via the gem
command-line tool. RubyGems also handles version management.

For more information:

RubyGems chapter from "Programming Ruby II":
<http://www.pragmaticprogrammer.com/titles/ruby/gems.pdf>

Announcement of RubyGems 0.8 release (Sep 2004):
<http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/112726>

RubyGems project wiki:
<http://rubygems.rubyforge.org/wiki/wiki.pl>

Happy gem writing.

Rob

Does Ruby have something equivelant to Perl's perlmodstyle[1] manual
page? Something that lays out the prefered style and conventions used
to create libraries. Little things like: How do you specify versions?
(grep shows usage of both VERSION and VERSION_MAJOR, VERSION_MINOR,
etc.)
Preferred documentation style. Naming. Error handling. Packaging &
configuration. etc.

Thanks,
Randy.

1. <http://perldoc.com/perl5.8.4/pod/perlmodstyle.html>

__________________________________
Do you Yahoo!?
Yahoo! Mail - 50x more storage than other providers!
http://promotions.yahoo.com/new_mail

 

[David Ross]

By the way. For packaging, there is RPA base
http://rpa-base.rubyforge.org

It is a CPAN-like manager. The port committers handle
your software pacakging. Customized packaging
available upon request.

Here is another versioning site. Which it indicated
software should start at 1.0. I have to agree that is
the better idea for a full feature release

http://www.jmock.org/versioning.html

Here are good practices to follow
http://rpa-base.rubyforge.org/wiki/wiki.cgi?GoodPractices

Good luck on programming

--dross

Does Ruby have something equivelant to Perl's
perlmodstyle[1] manual
page? Something that lays out the prefered style and
conventions used to
create libraries. Little things like: How do you
specify versions? (grep
shows usage of both VERSION and VERSION_MAJOR,
VERSION_MINOR, etc.)
Preferred documentation style. Naming. Error
handling. Packaging &
configuration. etc.

Thanks,
Randy.

1.
<http://perldoc.com/perl5.8.4/pod/perlmodstyle.html>

__________________________________
Do you Yahoo!?
New and Improved Yahoo! Mail - 100MB free storage!
http://promotions.yahoo.com/new_mail

 

[Marcel Molina Jr.]

Does Ruby have something equivelant to Perl's perlmodstyle[1] manual
page? Something that lays out the prefered style and conventions used to
create libraries. Little things like: How do you specify versions? (grep
shows usage of both VERSION and VERSION_MAJOR, VERSION_MINOR, etc.)
Preferred documentation style. Naming. Error handling. Packaging &
configuration. etc.

Thanks,
Randy.

1. <http://perldoc.com/perl5.8.4/pod/perlmodstyle.html>

these are the things that seems related to the style issue:
http://www.rubygarden.org/ruby?RubyStyleGuide
http://www.caliban.org/ruby/rubyguide.shtml#style

though none of those links are *official* ruby guidelines...does anyone
know if there is any such thing? a sort of, "best practices" manifesto?

i suppose you could get some idea but just copying the style of ruby
stuff that Matz has worked on.

marcel