Module: REXML::Functions

Module REXML::Functions |
In: | src/rexml/functions.rb

If you add a method, keep in mind two things: (1) the first argument will always be a list of nodes from which to filter. In the case of context methods (such as position), the function should return an array with a value for each child in the array. (2) all method calls from XML will have "-" replaced with "_". Therefore, in XML, "local-name()" is identical (and actually becomes) "local_name()"

Methods

boolean ceiling compare_language concat contains count false floor get_namespace id index index= lang last local_name method_missing name namespace_context namespace_context= namespace_uri node node= normalize_space not number position round size size= starts_with string string_length substring substring_after substring_before sum text translate true variables variables=

Public Class methods

node=(value)

index=(value)

size=(value)

variables=(value)

namespace_context=(value)

node()

index()

size()

variables()

namespace_context()

text( )

last( )

position( )

count( node_set )

id( object )

Since REXML is non-validating, this method is not implemented as it requires a DTD

local_name( node_set=nil )

UNTESTED

namespace_uri( node_set=nil )

name( node_set=nil )

get_namespace( node_set = nil ) {|@@node if defined? @@node.namespace| ...}

Helper method.

string( object=nil )

A node-set is converted to a string by returning the string-value of the node in the node-set that is first in document order. If the node-set is empty, an empty string is returned.

A number is converted to a string as follows

NaN is converted to the string NaN

positive zero is converted to the string 0

negative zero is converted to the string 0

positive infinity is converted to the string Infinity

negative infinity is converted to the string -Infinity

if the number is an integer, the number is represented in decimal form as a Number with no decimal point and no leading zeros, preceded by a minus sign (-) if the number is negative

otherwise, the number is represented in decimal form as a Number including a decimal point with at least one digit before the decimal point and at least one digit after the decimal point, preceded by a minus sign (-) if the number is negative; there must be no leading zeros before the decimal point apart possibly from the one required digit immediately before the decimal point; beyond the one required digit after the decimal point there must be as many, but only as many, more digits as are needed to uniquely distinguish the number from all other IEEE 754 numeric values.

The boolean false value is converted to the string false. The boolean true value is converted to the string true.

An object of a type other than the four basic types is converted to a string in a way that is dependent on that type.

concat( *objects )

UNTESTED

starts_with( string, test )

Fixed by Mike Stok

contains( string, test )

Fixed by Mike Stok

substring_before( string, test )

Kouhei fixed this

substring_after( string, test )

Kouhei fixed this too

substring( string, start, length=nil )

Take equal portions of Mike Stok and Sean Russell; mix vigorously, and pour into a tall, chilled glass. Serves 10,000.

string_length( string )

UNTESTED

normalize_space( string=nil )

UNTESTED

translate( string, tr1, tr2 )

This is entirely Mike Stok’s beast

boolean( object=nil )

UNTESTED

not( object )

UNTESTED

true( )

UNTESTED

false( )

UNTESTED

lang( language )

UNTESTED

compare_language(lang1, lang2)

number( object=nil )

a string that consists of optional whitespace followed by an optional minus sign followed by a Number followed by whitespace is converted to the IEEE 754 number that is nearest (according to the IEEE 754 round-to-nearest rule) to the mathematical value represented by the string; any other string is converted to NaN

boolean true is converted to 1; boolean false is converted to 0

a node-set is first converted to a string as if by a call to the string function and then converted in the same way as a string argument

an object of a type other than the four basic types is converted to a number in a way that is dependent on that type

sum( nodes )

floor( number )

ceiling( number )

round( number )

method_missing( id )