diff options
| author | matz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2008-12-03 00:31:58 +0000 |
|---|---|---|
| committer | matz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2008-12-03 00:31:58 +0000 |
| commit | 684f94c0edfca1d2ffbb9caefca95310f4f1da31 (patch) | |
| tree | 17a7308f3227c2989dc9f67dd992ab50e8e52432 /lib | |
| parent | 7fd3ac4895af97a69e96ce303e56896e6243df41 (diff) | |
* lib/rexml/xpath.rb (REXML::XPath.first): apply documentation
patch from Ken Bloom in [ruby-core:20213].
* lib/rexml/xpath.rb (REXML::XPath.each): ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@20454 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/rexml/xpath.rb | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/rexml/xpath.rb b/lib/rexml/xpath.rb index 7c5c258ad9..b22969ec8c 100644 --- a/lib/rexml/xpath.rb +++ b/lib/rexml/xpath.rb @@ -15,10 +15,15 @@ module REXML # node matching '*'. # namespaces:: # If supplied, a Hash which defines a namespace mapping. + # variables:: + # If supplied, a Hash which maps $variables in the query + # to values. This can be used to avoid XPath injection attacks + # or to automatically handle escaping string values. # # XPath.first( node ) # XPath.first( doc, "//b"} ) # XPath.first( node, "a/x:b", { "x"=>"http://doofus" } ) + # XPath.first( node, '/book/publisher/text()=$publisher', {}, {"publisher"=>"O'Reilly"}) def XPath::first element, path=nil, namespaces=nil, variables={} raise "The namespaces argument, if supplied, must be a hash object." unless namespaces.nil? or namespaces.kind_of?(Hash) raise "The variables argument, if supplied, must be a hash object." unless variables.kind_of?(Hash) @@ -38,10 +43,16 @@ module REXML # The xpath to search for. If not supplied or nil, defaults to '*' # namespaces:: # If supplied, a Hash which defines a namespace mapping + # variables:: + # If supplied, a Hash which maps $variables in the query + # to values. This can be used to avoid XPath injection attacks + # or to automatically handle escaping string values. # # XPath.each( node ) { |el| ... } # XPath.each( node, '/*[@attr='v']' ) { |el| ... } # XPath.each( node, 'ancestor::x' ) { |el| ... } + # XPath.each( node, '/book/publisher/text()=$publisher', {}, {"publisher"=>"O'Reilly"}) \ + # {|el| ... } def XPath::each element, path=nil, namespaces=nil, variables={}, &block raise "The namespaces argument, if supplied, must be a hash object." unless namespaces.nil? or namespaces.kind_of?(Hash) raise "The variables argument, if supplied, must be a hash object." unless variables.kind_of?(Hash) |