Standard Library

---

Ruby comes ``out of the box'' with a large and useful library of modules and classes. This chapter contains a sampling of the more useful of these. Interestingly, and unlike some of the code in later chapters, all of these libraries are written in Ruby. You'll find the source in the lib subdirectory of the standard Ruby distribution.

Index:

new Arithmetic operations <=> == abs abs2 arg conjugate image polar real to_f to_i to_r to_s

---

Returns a + b_i. In addition to the Complex.new constructor, the Complex library defines the method Numeric.im , such that aNumeric .im returns 0 + aNumeric _i. Complex numbers are also constructed using the global method Complex, which takes one or two arguments. The value it returns depends on the type of its arguments: Performs various arithmetic operations on ref. Returns ref.abs <=> other.abs. If anObject is a complex number, returns true if its real and imaginary parts match ref. If anObject is a simple number, returns true if ref.real equals anObject and ref.image is zero. Otherwise, attempts to coerce anObject to a complex number and compares the result. Absolute value. Square of absolute value. Argument (angle from (1,0)). Complex conjugate. The imaginary part of ref. Returns the two-element array: [c.abs, c.arg]. The real part of ref. Returns Complex(real.to_f, image.to_f). Returns Complex(real.to_i, image.to_i). Returns Complex(real.to_r, image.to_r), converting both parts of the complex to a rational number. String representation of ref. In addition, the Math functions sqrt, exp, cos, sin, tan, log, log10, and atan2 are extended to support a Complex argument.

Index:

exist2? exist? existw? gregorian_leap? julian_leap? leap? new new1 new2 new3 neww today Accessors + -- << <=> === >> downto england gregorian italy jd julian leap? mjd newsg next ns? os? sg step succ to_s upto

---

The date library implements class Date, which provides a comprehensive set of facilities for storing, manipulating, and converting dates. To document its options, we need to take a brief historical detour to establish some vocabulary. Internally a date is stored as a Julian day number, the number of days since midday, January 1st, 4713 BCE.[In the code, you may find references to the year -4712. As astronomical dates include a year zero, 4713 BCE is the same year as -4712.] The rules for converting a Julian day number to a calendar date are complicated because the Romans estimated the length of a year incorrectly. In the Julian calendar (often called Old Style, or O.S.), every year divisible by 4 is a leap year. The Date class has options to convert dates using this as an assumption. By the sixteenth century, the inaccuracies in this measurement had become apparent. An edict from Pope Gregory XIII in 1582 created the New Style (N.S.) or Gregorian calendar, where years divisible by 100 were no longer leap years unless they were also divisible by 400. This system was adopted by most Catholic countries immediately, but religious differences held up a wider adoption. England (and several other countries) switched in 1752, with some countries following later. The Date class allows you to determine whether to implement the cutover in 1582 (the Date::ITALY option), 1752 (Date::ENGLAND), or another date of your choosing. The Date class also provides conversions to Modified Julian Day (MJD) numbers. MJD values count from midnight, November 17, 1858. Because these values count from midnight, not midday, there is a half-day added to the conversion factor. The descriptions that follow use the abbreviations listed in Table 24.1 on page 441. Class Date exports the constant arrays Date::MONTHNAMES and Date::DAYNAMES, which can be indexed by mon and wday values to return the corresponding English names. The Date class also provides low-level date-conversion methods: These methods perform limited error checking of their parameters, and are not documented here. The somewhat confusingly named exist..? routines perform conversions from different formats into a Julian day number with error checking. These routines also automatically normalize their parameters. Converts a year and yday into a Julian day number, returning nil on error. Converts a year, mon, and mday into a Julian day number, or nil if the parameters are invalid. Converts a cyear, cweek, and cwday into a Julian day number. If year does not end with ``00'', returns true if year is divisible by 4, otherwise returns true if year is divisible by 400. Returns true if year is divisible by 4. Synonym for Date.gregorian_leap?. Returns a Date for the given year, mon, and mday. If mon is negative, it counts back from the end of the year. If mday is negative, it counts back from the end of the month. Creates a Date corresponding to the given Julian day number. Returns a Date for the given year and yday. If yday is negative, it counts back from the end of the year. Synonym for Date.new. Returns a Date for the given cyear, cweek, and cwday. If cweek is negative, it counts back from the end of the year. If cwday is negative, it counts back from the end of the week. Returns a Date for today. Returns the given component of ref as a number. Returns a new Date anInteger days from ref. The first form returns a new Date anInteger days before ref. The second form returns the number of days between ref and anOtherDate. Returns a new Date formed by subtracting anInteger months to ref, adjusting the mday value back to the last day of the month if it otherwise exceeds it. anOther must be a Numeric, in which case it is treated as a Julian day number, or a Date. Returns -1, 0, +1 if ref is less than, equal to, or greater than anOther. See module Comparable on page 402. anOther must be a Numeric, in which case it is treated as a Julian day number, or a Date. Returns true if the Julian day number of anOther is the same as ref. Returns a new Date formed by adding anInteger months to ref, adjusting the mday value back to the last day of the month if it otherwise exceeds it. Invokes block with dates from ref down to aDateMin. Equivalent to ref .newsg(Date::ENGLAND). Equivalent to ref .newsg(Date::GREGORIAN). Equivalent to ref .newsg(Date::ITALY). Returns the Julian day number for ref. Equivalent to ref .newsg(Date::JULIAN). Returns true if ref falls within a leap year. Returns the Julian day number of ref converted to a modified Julian day number. Returns a new Date. Synonym for ref.succ. Returns true if ref falls in the period of New Style dates. Returns true if ref falls in the period of Old Style dates. Returns the Julian day number of the start of New Style dates for ref. Invokes block with dates starting at ref, incrementing by step days, ending at the first date greater than aDateLimit (less than for a negative step). Returns the date of ref plus one day. Returns self as ``year-mon-mday.'' Invokes block with dates from ref to aDateMax. produces: Include the English library file in a Ruby script, and you can reference the global variables such as $_ using less cryptic names, listed in the following table.

Index:

find prune

---

produces: The Find module supports the top-down traversal of a set of file paths. Calls the associated block with the name of every file and directory listed as arguments, then recursively on their subdirectories, and so on. Skips the current file or directory, restarting the loop with the next entry. If the current file is a directory, that directory will not be recursively entered. Meaningful only within the block associated with Find::find.

Index:

cmp compare copy cp install makedirs mkpath move mv rm_f safe_unlink syscopy

---

The FTools library adds several methods to the built-in File class. These methods are particularly useful to programs that move and copy files, such as installers. Synonym for File.compare . Returns true only if the contents of files name1 and name2 are identical. Equivalent to calling File.syscopy , but logs the attempt to $stderr if verbose is not false. Synonym for File.copy . Copies file fromName to file toName using File.syscopy , unless toName already exists and has the same content as fromName. Sets the mode of the resulting file to aMode unless aMode is nil. Creates the given directories, logging each attempt to $stderr if the last parameter is true. Creates any missing parent directories as required. Synonym for File.makedirs . Effectively renames fromName to toName, logging to $stderr if verbose is not false. Synonym for File.move . Synonym for File.safe_unlink (the name refers to the Unix rm -f command). Unlinks (deletes) the given files, logging to $stderr if the last parameter is true. The method attempts to make all files writable before unlinking them, so no errors will occur deleting read-only files. Returns the number of files deleted, or nil on error. Efficiently copies the file named fromName to toName. If toName names a directory, the destination will be a file in that directory with the same basename as fromName. After the copy, the file mode of toName will be the same as that of fromName. Returns true on success.

Index:

new each error? error_message get get_option ordering ordering= quiet quiet= quiet? set_options terminate terminated?

---

produces: Class GetoptLong supports GNU-style command-line option parsing. Options may be a minus sign (`-') followed by a single character, or two minus signs (`--') followed by a name (a long option). Long options may be abbreviated to their shortest unambiguous lengths. A single internal option may have multiple external representations. For example, the option to control verbose output could be any of -v, --verbose, or --details. Some options may also take an associated value. Each internal option is passed to GetoptLong as an array, containing strings representing the option's external forms and a flag. The flag (NO_ARGUMENT, REQUIRED_ARGUMENT, or OPTIONAL_ARGUMENT) specifies how GetoptLong is to associate an argument with the option. If the environment variable POSIXLY_CORRECT is set, all options must precede nonoptions on the command line. Otherwise, the default behavior of GetoptLong is to reorganize the command line to put the options at the front. This behavior may be changed by setting GetoptLong#ordering= to one of the constants PERMUTE, REQUIRE_ORDER, or RETURN_IN_ORDER. POSIXLY_CORRECT may not be overridden. Returns a new option parser. Any options are passed to ref.set_options. Loops calling GetoptLong#get, passing the returned option and argument to the associated block. The loop ends when get returns nil for anOption. Returns an Exception object documenting any error that has occurred, or nil if there has not been an error. Returns the text of the last error message. Returns the next option, along with any associated argument. If there is no argument, nil is returned for anArgument. If there are no remaining unprocessed options, or if there is an error in option processing and quiet has been set, nil is returned for anOption. Otherwise, if there is an error, a message is written to $stderr and an exception (a subclass of StandardError) is raised. The option string returned is the first option that was given in the corresponding array passed to set_options. Synonym for GetoptLong#get. Returns the current ordering. Sets the ordering to one of PERMUTE, REQUIRE_ORDER, or RETURN_IN_ORDER. Quietly ignored if the environment variable POSIXLY_CORRECT is set. Ordering may not be changed once option processing has been started. Returns the current value of the quiet attribute. Sets the current value of the quiet attribute. If false, any errors encountered are reported to $stderr. Synonym for GetoptLong#quiet. Each parameter is an array specifying a single internal option. The array contains one or more strings specifying the external form(s) of the option, and one of the flags NO_ARGUMENT, OPTIONAL_ARGUMENT, or REQUIRED_ARGUMENT. See the sample code on page 448 for examples of use. Terminates option processing. Any remaining arguments are written back to ARGV. This may be called from within a GetoptLong#each or on its own. For example, calling the following program using ``ruby example.rb --size 10k -v -term -q a.txt b.doc'' will leave the -q and filenames in ARGV. produces: Returns true if option processing has been terminated.

Index:

create_makefile dir_config find_library have_func have_header have_library

---

The mkmf library is used by Ruby extension modules to help create Makefiles. When writing an extension, you create a program named ``extconf.rb'', which may be as simple as: When run, this script will produce a Makefile suited to the target platform. mkmf contains several methods you can use to find libraries and include files and to set compiler flags. For more information on creating extension modules, see Chapter 17, which begins on page 169. Creates a Makefile for an extension named target. If this method is not called, no Makefile is created. Looks for directory configuration options for name given as arguments to this program or to the original build of Ruby. These arguments may be one of: The given directories will be added to the appropriate search paths (include or link) in the Makefile. Same as have_library, but will also search in the given directory paths. If the named function exists in the standard compile environment, adds the directive -DHAVE_FUNCTION to the compile command in the Makefile and returns true. If the given header file can be found in the standard search path, adds the directive -DHAVE_HEADER to the compile command in the Makefile and returns true. If the given function exists in the named library, which must exist in the standard search path or in a directory added with dir_config, adds the library to the link command in the Makefile and returns true.

Index:

parsedate

---

The ParseDate module defines a single method, ParseDate::parsedate, which converts a date and/or time string into its constituents. It uses heuristics that handle a wide variety of date and time formats, including a subset of ISO 8601, Unix ctime, and most common written variants. The following table shows some examples. Parses a string containing a date and/or a time, returning an array of Fixnum objects containing the various components. nil is returned for fields that cannot be parsed from aString. If the result contains a year that is less than 100 and guessYear is true, parsedate will return a year value equal to year plus 2000 if year is less than 69, year plus 1900 otherwise. The profile library prints to $stderr a summary of the number of calls to, and the time spent in, each method in a Ruby program. The output is sorted by the total time spent in each method. Profiling can be enabled from the command line using the -r profile option, or from within a source program by requiring the profile module. produces:

Index:

new [ ] [ ]= abort commit path root? roots transaction

---

The PStore class provides transactional, file-based persistent storage of Ruby objects. The following example stores two hierarchies in a PStore. The first, identified by the key ``names'', is an array of Strings. The second, identified by ``tree'', is a simple binary tree. produces: Each PStore can store several object hierarchies. Each hierarchy has a root, identified by a key (often a string). At the start of a PStore transaction, these hierarchies are read from a disk file and made available to the Ruby program. At the end of the transaction, the hierarchies are written back to the file. Any changes made to objects in these hierarchies are therefore saved on disk, to be read at the start of the next transaction that uses that file. In normal use, a PStore object is created and then is used one or more times to control a transaction. Within the body of the transaction, any object hierarchies that had previously been saved are made available, and any changes to object hierarchies, and any new hierarchies, are written back to the file at the end. Returns a new PStore object associated with the given file. If the file exists, its contents must have been previously written by PStore. Root Access---Returns the root of an object hierarchy identified by anObject. An exception is raised if anObject does not identify a root. Root Creation---Sets anOtherObject as the base of the object hierarchy to be identified using anObject. Terminates this transaction, losing any changes made to the object hierarchies. Terminates the current transaction, saving the object hierarchies into the store's file. Returns the name of the file associated with this store. Returns true if anObject is the key of a root in this store. Returns an array containing the keys of the root objects available in this store. If the file associated with ref exists, reads in the object hierarchies from it. It then executes the associated block, passing in ref. The block may use this parameter to access the roots of the hierarchies and hence access the persistent objects. If the block calls PStore#abort, or if it raises an exception, no data is saved back to the associated file. Otherwise, if it invokes PStore#commit, or if it terminates normally, the object hierarchies are written back to the file. The value returned is the value returned by the block.

Index:

new close open path

---

Class Tempfile creates managed temporary files. Although they behave the same as any other IO objects, temporary files are automatically deleted when the Ruby program terminates. Once a Tempfile object has been created, the underlying file may be opened and closed a number of times in succession. Tempfile does not directly inherit from IO. Instead, it delegates calls to a File object. From the programmer's perspective, apart from the unusual new, open, and close semantics, a Tempfile object behaves as if it were an IO object. Constructs a temporary file in the given directory. The file name is built by concatenating basename, the current process id and (as an extension) a unique sequence number. If the tmpdir parameter is not supplied, it defaults to the value of one of the environment variables TMPDIR, TMP, or TEMP, or to the directory /tmp. The file is then opened using mode ``w+'', which allows reading and writing and deletes any existing content (see Table 22.5 on page 326). Synonym for Tempfile.new. Closes ref. If final is true, deletes the underlying real file. If final is false, ref may be subsequently reopened. In all cases, the underlying file is deleted when the program terminates. Reopens ref using mode ``r+'', which allows reading and writing but does not delete existing content. Returns the full path of the underlying file.

Index:

lock locked? synchronize try_lock unlock

---

Mutex implements a simple semaphore that can be used to coordinate access to shared data from multiple concurrent threads. Attempts to grab the lock and waits if it isn't available. Returns true if this lock is currently held by some thread. Obtains a lock (using Mutex#lock), runs the block, and releases the lock when the block completes. Attempts to obtain the lock and returns immediately. Returns true if the lock was granted. Releases the lock. Returns nil if ref wasn't locked.

Index:

broadcast signal wait

---

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 (see the discussion on page 117). Wakes up all threads waiting for this lock. Wakes up the first thread in line waiting for this lock. Releases the lock held in aMutex and waits; reacquires the lock on wakeup. produces: The timeout method takes a single parameter, representing a timeout period in seconds, and a block. The block is executed, and a timer is run concurrently. If the block terminates before the timeout, timeout returns true. Otherwise, a TimeoutError exception is raised.

Index:

new weakref_alive?

---

produces: In Ruby, objects are not eligible for garbage collection if there are still references to them. Normally, this is a Good Thing---it would be disconcerting to have an object simply evaporate while you were using it. However, sometimes you may need more flexibility. For example, you might want to implement an in-memory cache of commonly used file contents. As you read more files, the cache grows. At some point, you may run low on memory. The garbage collector will be invoked, but the objects in the cache are all referenced by the cache data structures, and so will not be deleted. A weak reference behaves exactly as any normal object reference with one important exception---the referenced object may be garbage collected, even while references to it exist. In the cache example, if the cached files were accessed using weak references, once memory runs low they will be garbage collected, freeing memory for the rest of the application. Weak references introduce a slight complexity. As the object referenced can be deleted by garbage collection at any time, code that accesses these objects must take care to ensure that the references are valid. Two techniques can be used. First, the code can reference the objects normally. Any attempt to reference an object that has been garbage collected will raise a WeakRef::RefError exception. An alternative approach is to use the WeakRef#weakref_alive? method to check that a reference is valid before using it. Garbage collection must be disabled during the test and subsequent reference to the object. In a single-threaded program, you could use something like: Creates and returns a weak reference to anObject. All future references to anObject should be made using ref. Returns false if the object referenced by ref has been garbage collected.

---

Extracted from the book "Programming Ruby - The Pragmatic Programmer's Guide"
Copyright © 2001 by Addison Wesley Longman, Inc. This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/)). Distribution of substantively modified versions of this document is prohibited without the explicit permission of the copyright holder. Distribution of the work or derivative of the work in any standard (paper) book form is prohibited unless prior permission is obtained from the copyright holder.