Class: REXML::Entity
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Child
|
|
Instance Chain:
|
|
Inherits: |
REXML::Child
|
Defined in: | lib/rexml/entity.rb |
Overview
God, I hate DTDs. I really do. Why this idiot standard still plagues us is beyond me.
Constant Summary
-
ENTITYDECL =
# File 'lib/rexml/entity.rb', line 22/\s*(?:#{GEDECL})|(?:#{PEDECL})/um
-
ENTITYDEF =
# File 'lib/rexml/entity.rb', line 19"(?:#{ENTITYVALUE}|(?:#{EXTERNALID}(#{NDATADECL})?))"
-
ENTITYVALUE =
# File 'lib/rexml/entity.rb', line 17%Q{((?:"(?:[^%&"]|#{PEREFERENCE}|#{REFERENCE})*")|(?:'([^%&']|#{PEREFERENCE}|#{REFERENCE})*'))}
-
EXTERNALID =
# File 'lib/rexml/entity.rb', line 14"(?:(?:(SYSTEM)\\s#{SYSTEMLITERAL})|(?:(PUBLIC)\\s#{PUBIDLITERAL}\\s+#{SYSTEMLITERAL}))"
-
GEDECL =
# File 'lib/rexml/entity.rb', line 21"<!ENTITY\\s#{NAME}\\s#{ENTITYDEF}\\s*>"
-
NDATADECL =
# File 'lib/rexml/entity.rb', line 15"\\sNDATA\\s#{NAME}"
-
PEDECL =
# File 'lib/rexml/entity.rb', line 20"<!ENTITY\\s(%)\\s#{NAME}\\s+#{PEDEF}\\s*>"
-
PEDEF =
# File 'lib/rexml/entity.rb', line 18"(?:#{ENTITYVALUE}|#{EXTERNALID})"
-
PEREFERENCE =
# File 'lib/rexml/entity.rb', line 16"%#{NAME};"
-
PEREFERENCE_RE =
# File 'lib/rexml/entity.rb', line 128/#{PEREFERENCE}/um
-
PUBIDCHAR =
# File 'lib/rexml/entity.rb', line 11"\x20\x0D\x0Aa-zA-Z0-9\\-()+,./:=?;!*@$_%#"
-
PUBIDLITERAL =
# File 'lib/rexml/entity.rb', line 13%Q{("[#{PUBIDCHAR}']*"|'[#{PUBIDCHAR}]*')}
-
SYSTEMLITERAL =
# File 'lib/rexml/entity.rb', line 12%Q{((?:"[^"]*")|(?:'[^']*'))}
XMLTokens - Included
NAME, NAMECHAR, NAME_CHAR, NAME_START_CHAR, NAME_STR, NCNAME_STR, NMTOKEN, NMTOKENS, REFERENCE
Class Method Summary
-
.matches?(string) ⇒ Boolean
Evaluates whether the given string matches an entity definition, returning true if so, and false otherwise.
-
.new(stream, value = nil, parent = nil, reference = false) ⇒ Entity
constructor
Create a new entity.
Child - Inherited
.new | Constructor. |
Instance Attribute Summary
Child - Inherited
#next_sibling | Alias for Node#next_sibling_node. |
#next_sibling= | Sets the next sibling of this child. |
#parent | The Parent of this object. |
#parent= | Sets the parent of this child to the supplied argument. |
#previous_sibling | Alias for Node#previous_sibling_node. |
#previous_sibling= | Sets the previous sibling of this child. |
Node - Included
Instance Method Summary
-
#normalized
Returns the value of this entity unprocessed – raw.
-
#to_s
Returns this entity as a string.
-
#unnormalized
Evaluates to the unnormalized value of this entity; that is, replacing all entities – both %ent; and &ent; entities.
-
#value
Returns the value of this entity.
-
#write(out, indent = -1)
Write out a fully formed, correct entity definition (assuming the
Entity
object itself is valid.).
Child - Inherited
#bytes | This doesn't yet handle encodings. |
#document |
|
#remove | Removes this child from the parent. |
#replace_with | Replaces this object with another object. |
Node - Included
#each_recursive | Visit all subnodes of |
#find_first_recursive | Find (and return) first subnode (recursively) for which the block evaluates to true. |
#indent, | |
#index_in_parent | Returns the position that |
#next_sibling_node, #previous_sibling_node, | |
#to_s |
|
Constructor Details
.new(stream, value = nil, parent = nil, reference = false) ⇒ Entity
Create a new entity. Simple entities can be constructed by passing a name, value to the constructor; this creates a generic, plain entity reference. For anything more complicated, you have to pass a Source to the constructor with the entity definition, or use the accessor methods. WARNING
: There is no validation of entity state except when the entity is read from a stream. If you start poking around with the accessors, you can easily create a non-conformant Entity
. The best thing to do is dump the stupid DTDs and use XMLSchema instead.
e = Entity.new( 'amp', '&' )
# File 'lib/rexml/entity.rb', line 36
def initialize stream, value=nil, parent=nil, reference=false super(parent) @ndata = @pubid = @value = @external = nil if stream.kind_of? Array @name = stream[1] if stream[-1] == '%' @reference = true stream.pop else @reference = false end if stream[2] =~ /SYSTEM|PUBLIC/ @external = stream[2] if @external == 'SYSTEM' @ref = stream[3] @ndata = stream[4] if stream.size == 5 else @pubid = stream[3] @ref = stream[4] end else @value = stream[2] end else @reference = reference @external = nil @name = stream @value = value end end
Class Method Details
.matches?(string) ⇒ Boolean
Evaluates whether the given string matches an entity definition, returning true if so, and false otherwise.
# File 'lib/rexml/entity.rb', line 69
def Entity::matches? string (ENTITYDECL =~ string) == 0 end
Instance Attribute Details
#external (readonly)
[ GitHub ]#name (readonly)
[ GitHub ]#ndata (readonly)
[ GitHub ]#pubid (readonly)
[ GitHub ]#ref (readonly)
[ GitHub ]Instance Method Details
#normalized
Returns the value of this entity unprocessed – raw. This is the normalized value; that is, with all %ent; and &ent; entities intact
# File 'lib/rexml/entity.rb', line 88
def normalized @value end
#to_s
Returns this entity as a string. See write().
# File 'lib/rexml/entity.rb', line 122
def to_s rv = '' write rv rv end
#unnormalized
Evaluates to the unnormalized value of this entity; that is, replacing all entities – both %ent; and &ent; entities. This differs from value() in that #value only replaces %ent; entities.
# File 'lib/rexml/entity.rb', line 76
def unnormalized document.record_entity_expansion unless document.nil? v = value() return nil if v.nil? @unnormalized = Text::unnormalize(v, parent) @unnormalized end
#value
Returns the value of this entity. At the moment, only internal entities are processed. If the value contains internal references (IE, %blah;), those are replaced with their values. IE, if the doctype contains:
<!ENTITY % foo "bar">
<!ENTITY yada "nanoo %foo; nanoo>
then:
doctype.entity('yada').value #-> "nanoo bar nanoo"
# File 'lib/rexml/entity.rb', line 137
def value if @value matches = @value.scan(PEREFERENCE_RE) rv = @value.clone if @parent sum = 0 matches.each do |entity_reference| entity_value = @parent.entity( entity_reference[0] ) if sum + entity_value.bytesize > Security.entity_expansion_text_limit raise "entity expansion has grown too large" else sum += entity_value.bytesize end rv.gsub!( /%#{entity_reference.join};/um, entity_value ) end end return rv end nil end
#write(out, indent = -1)
Write out a fully formed, correct entity definition (assuming the Entity
object itself is valid.)
- out
-
An object implementing <TT><<<TT> to which the entity will be output
- indent
-
DEPRECATED and ignored
# File 'lib/rexml/entity.rb', line 100
def write out, indent=-1 out << '<!ENTITY ' out << '% ' if @reference out << @name out << ' ' if @external out << @external << ' ' if @pubid q = @pubid.include?('"')?"'":'"' out << q << @pubid << q << ' ' end q = @ref.include?('"')?"'":'"' out << q << @ref << q out << ' NDATA ' << @ndata if @ndata else q = @value.include?('"')?"'":'"' out << q << @value << q end out << '>' end