Library

Standard Library 1.8.6

Updated 1 day ago.

README this file inf-ruby.el program to run ruby under emacs ruby-mode.el ruby mode for emacs rubydb2x.el ruby debugger support for emacs 19.2x or before rubydb3x.el ruby debugger support for emacs 19.3x or later ruby-electric.el emacs minor mode providing electric commands rdebug.el ruby-debug (rdebug) support for emacs 19.3x or later

Modules
Abbrev Calculate the set of unique abbreviations for a given set of strings.
Acceptables Acceptable argument classes. Now contains DecimalInteger, OctalInteger and DecimalNumeric. See Acceptable argument classes (in source code).
Arguable Extends command line arguments array (ARGV) to parse itself.
Base64 The Base64 module provides for the encoding (#encode64) and decoding (#decode64) of binary data using a Base64 representation.
Benchmark The Benchmark module provides methods to measure and report the time used to execute Ruby code.
DOT
DRb for ruby-1.8.0
Enumerable
Errno compat.rb — cross platform compatibility
Exception2MessageMapper
ExceptionForMatrix
FileUtils Copyright © 2000-2006 Minero Aoki
Finalizer Usage:
Find The Find module supports the top-down traversal of a set of file paths.
Forwardable The Forwardable module provides delegation of specified methods to a designated object, using the methods #def_delegator and #def_delegators.
Generators
IRB irb/input-method.rb - input methods used irb
Kernel
Logging
Math
MonitorMixin Adds monitor functionality to an arbitrary object by mixing the module with include. For example:
Mutex_m Extend an object and use it like a Mutex object:
NQXML add some methods to NQXML::Node
Net
Observable Implements the Observable design pattern as a mixin so that other objects can be notified of changes in state. See observer.rb for details and an example.
Open3 Open3 grants you access to stdin, stdout, and stderr when running another program. Example:
OpenURI OpenURI is an easy-to-use wrapper for net/http, net/https and net/ftp.
ParseDate
Ping Ping contains routines to test for the reachability of remote hosts. Currently the only routine implemented is pingecho().
Profiler__
RDoc This is a template for RDoc that uses XHTML 1.0 Transitional and dictates a bit more of the appearance of the output to cascading stylesheets than the default. It was designed for clean inline code display, and uses DHTMl to toggle the visbility of each method’s source with each click on the ’[source]’ link.
REXML This class was contributed by Mikko Tiihonen mikko DOT tiihonen AT hut DOT fi
RI We handle the parsing of options, and subsequently as a singleton object to be queried for option values
RSS
RUNIT
Racc
RiDisplay This is a kind of ‘flag’ module. If you want to write your own ‘ri’ display module (perhaps because you’r writing an IDE or somesuch beast), you simply write a class which implements the various ‘display’ methods in ‘DefaultDisplay’, and include the ‘RiDisplay’ module in that class.
Rinda A module to implement the Linda distributed computing paradigm in Ruby.
RubyToken Definitions of all tokens involved in the lexical analysis
SM require ‘rdoc/markup/simple_markup/to_flow.rb’
SOAP This program is copyrighted free software by NAKAMURA, Hiroshi. You can redistribute it and/or modify it under the same terms of Ruby’s license; either the dual license version in 2003, or any later version.
Scanf
Shellwords This module is originally a port of shellwords.pl, but modified to conform to POSIX / SUSv3 (IEEE Std 1003.1-2001).
SingleForwardable The SingleForwardable module provides delegation of specified methods to a designated object, using the methods #def_delegator and #def_delegators. This module is similar to Forwardable, but it works on objects themselves, instead of their defining classes.
Singleton The Singleton module implements the Singleton pattern.
SingletonClassMethods
Sync_m
TSort TSort implements topological sorting using Tarjan’s algorithm for strongly connected components.
Test
Timeout A way of performing a potentially long-running operation in a thread, and terminating it’s execution if it hasn’t finished within fixed amount of time.
TokenStream A TokenStream is a list of tokens, gathered during the parse of some entity (say a method). Entities populate these streams by being registered with the lexer. Any class can collect tokens by including TokenStream. From the outside, you use such an object by calling the start_collecting_tokens method, followed by calls to add_token and pop_token
URI URI support for Ruby
WEBrick HTTPVersion.rb — presentation of HTTP version
WSDL This program is copyrighted free software by NAKAMURA, Hiroshi. You can redistribute it and/or modify it under the same terms of Ruby’s license; either the dual license version in 2003, or any later version.
XML
XMLEncoding_ja
XMLRPC Defines ParserWriterChooseMixin, which makes it possible to choose a different XML writer and/or XML parser then the default one. The Mixin is used in client.rb (class Client) and server.rb (class BasicServer)
XSD This program is copyrighted free software by NAKAMURA, Hiroshi. You can redistribute it and/or modify it under the same terms of Ruby’s license; either the dual license version in 2003, or any later version.
YAML Constants used throughout the library
Classes
ACL
AmbiguousArgument Raises when the given argument word can’t be completed uniquely.
AmbiguousOption Raises when ambiguously completable string is encountered.
Array
Bignum
CGI CGI class. See documentation for the file cgi.rb for an overview of the CGI protocol.
CSV This program is copyrighted free software by NAKAMURA, Hiroshi. You can redistribute it and/or modify it under the same terms of Ruby’s license; either the dual license version in 2003, or any later version.
Class
CompletingHash Hash with completion search feature. See OptionParser::Completion.
Complex The complex number class. See complex.rb for an overview.
ConditionVariable ConditionVariable objects augment class Mutex. Using condition variables, it is possible to suspend while in the middle of a critical section until a resource becomes available.
DEBUGGER__
Date Class representing a date.
DateTime Class representing a date and time.
DefaultDisplay A paging display module. Uses the ri_formatter class to do the actual presentation
Delegator Delegator is an abstract class used to build delegator pattern objects from subclasses. Subclasses should redefine __getobj__. For a concrete implementation, see SimpleDelegator.
Dir tmpdir - retrieve temporary directory path
ERB ERB provides an easy to use but powerful templating system for Ruby. Using ERB, actual Ruby code can be added to any plain text document for the purposes of generating document information details and/or flow control.
Exception
FalseClass
File This library can be distributed under the terms of the Ruby license. You can freely distribute/modify this library.
Fill
Fixnum
Float
Foo
GServer GServer implements a generic server, featuring thread pool management, simple logging, and multi-server management. See HttpServer in xmlrpc/httpserver.rb in the Ruby standard library for an example of GServer in action.
Generator Generator converts an internal iterator (i.e. an Enumerable object) to an external iterator.
GetoptLong The GetoptLong class allows you to parse command line options similarly to the GNU getopt_long() C library call. Note, however, that GetoptLong is a pure Ruby implementation.
Hash
HttpServer
IO
IPAddr IPAddr provides a set of methods to manipulate an IP address. Both IPv4 and IPv6 are supported.
Integer
InvalidArgument Raises when the given argument does not match required format.
InvalidOption Raises when switch is undefined.
List Simple option list providing mapping from short and/or long option string to OptionParser::Switch and mapping from acceptable argument to matching pattern and converter pair. Also provides summary feature.
Logger Simple logging utility.
Mail The Mail class represents an internet mail message (as per RFC822, RFC2822) with headers and a body.
MatchData
Matrix The Matrix class represents a mathematical matrix, and provides methods for creating special-case matrices (zero, identity, diagonal, singular, vector), operating on them arithmetically and algebraically, and determining their mathematical properties (trace, rank, inverse, determinant).
MissingArgument Raises when a switch with mandatory argument has no argument.
Module
Monitor Monitors provide means of mutual exclusion for Thread programming. A critical region is created by means of the synchronize method, which takes a block. The condition variables (created with #new_cond) may be used to control the execution of a monitor with #signal and #wait.
Mutex Mutex implements a simple semaphore that can be used to coordinate access to shared data from multiple concurrent threads.
NameDescriptor Break argument into its constituent class or module names, an optional method type, and a method name
NeedlessArgument Raises when there is an argument for a switch which takes no argument.
NilClass
NonString
Numeric Numeric is a built-in class on which Fixnum, Bignum, etc., are based. Here some methods are added so that all number types can be treated to some extent as Complex numbers.
Object
OpenStruct OpenStruct allows you to create data objects and set arbitrary attributes. For example:
OptionParser OptionParser is a class for command-line option analysis. It is much more advanced, yet also easier to use, than GetoptLong, and is a more Ruby-oriented solution.
Options
PP
PStore PStore implements a file based persistance mechanism based on a Hash. User code can store hierarchies of Ruby objects (values) into the data store file by name (keys). An object hierarchy may be just a single object. User code may later read values back from the data store or even update data, as needed.
ParseError Base class of exceptions from OptionParser.
Pathname Pathname represents a pathname which locates a file in a filesystem. The pathname depends on OS: Unix, Windows, etc. Pathname library works with pathnames of local OS. However non-Unix pathnames are supported experimentally.
PrettyPrint This class implements a pretty printing algorithm. It finds line breaks and nice indentations for grouped structure.
Prime
Queue This class provides a way to synchronize communication between threads.
Range
Rational Rational implements a rational class for numbers.
RegAnd
RegOr this is just a proof of concept toy.
Regexp
Resolv
RiDriver
RiError
RubyLex Lexical analyzer for Ruby source
SOCKSSocket
Set Set implements a collection of unordered values with no duplicates. This is a hybrid of Array’s intuitive inter-operation facilities and Hash’s fast lookup.
Shell version.rb - shell version definition file
SimpleDelegator A concrete implementation of Delegator, this class provides the means to delegate all supported method calls to the object passed into the constructor and even to change the object being delegated to at a later time with __setobj__ .
SizedQueue This class represents queues of specified size capacity. The push operation may be blocked if the capacity is full.
Socket
SortedSet SortedSet implements a set which elements are sorted in order. See Set.
StrictPrettyExample
String
StringIO StringIO based on code by MoonWolf
Struct
Symbol
Sync
SyncEnumerator SyncEnumerator creates an Enumerable object from multiple Enumerable objects and enumerates them synchronously.
TCPSocket
TSortArray
TSortHash
TSortTest
TailGroup
Tempfile A class for managing temporary files. This library is written to be thread safe.
TemplatePage Cheap-n-cheerful HTML page template system. You create a template containing:
TestInline
TestParse
Thread
ThreadsWait This class watches for termination of multiple threads. Basic functionality (wait until specified threads have terminated) can be accessed through the class method ThreadsWait::all_waits. Finer control can be gained using instance methods.
Time Implements the extensions to the Time class that are described in the documentation for the time.rb library.
TimeExtentionTest
Tracer tracer main class
TrueClass
TruncatedDataError TruncatedDataError is raised when IO#readbytes fails to read enough data.
UDPSocket
Vector The Vector class represents a mathematical vector, which is useful in its own right, and also constitutes a row or column of a Matrix.
WadlerExample
WeakRef WeakRef is a class to represent a reference to an object that is not seen by the tracing phase of the garbage collector. This allows the referenced object to be garbage collected as if nothing is referring to it. Because WeakRef delegates method calls to the referenced object, it may be used in place of that object, i.e. it is of the same duck type.
XMP
Comments

Have your say
Please use Textile formatting (click here for a cheat sheet). Use <code/> and <pre/> for code samples.
Click here to login with OpenID to to post comments.