xpath abbreviate: add support for string literal that contains double-quote by pulver · Pull Request #96 · ruby/rexml

pulver · 2023-05-25T13:00:57Z

This adds support for a string literal that contains a double-quote to XPathParser#abbreviate. Basically any literal that contains a double-quote " must be quoted by single-quotes ' since XPath 1.0 does not support any escape characters.

The change improves the following test script

require 'rexml'

parsed = REXML::Parsers::XPathParser.new.parse('/a[b/text()=concat("c\'",\'"d\')]')
puts "#{parsed}"
puts ""
appreviated = REXML::Parsers::XPathParser.new.abbreviate parsed
puts "#{appreviated}"

Output Before Change

[:document, :child, :qname, "", "a", :predicate, [:eq, [:child, :qname, "", "b", :child, :text], [:function, "concat", [[:literal, "c'"], [:literal, "\"d"]]]]]

/a[ b/text() = concat( "c'" , "\"d" ) ]

Output After Change

[:document, :child, :qname, "", "a", :predicate, [:eq, [:child, :qname, "", "b", :child, :text], [:function, "concat", [[:literal, "c'"], [:literal, "\"d"]]]]]

/a[ b/text() = concat( "c'" , '"d' ) ]

kou

Does this work with a number literal?

pulver · 2023-05-25T21:53:41Z

Good catch, thank you. I restored the previous method of literal.inspect for all non-Strings.

I wasn't sure how to handle this literal translation so I left it as it was:

rexml/lib/rexml/parsers/xpathparser.rb

Lines 86 to 87 in 54b7109

    
           when :literal 
        
             string << %Q{ "#{path.shift}" }

kou · 2023-05-26T05:21:10Z

lib/rexml/parsers/xpathparser.rb

        path
      end

+      def QuoteLiteral literal


Could you use snake_case?

Suggested change

def QuoteLiteral literal

def quote_literal(literal)

And could you move this method to before #LocalPath (the line 192)?
Method in #LocationPath to #FunctionCall are for syntaxes in XPath. I don't want to mix this and them.

kou · 2023-05-26T05:21:17Z

lib/rexml/parsers/xpathparser.rb

+      def QuoteLiteral literal
+        case literal
+        when String
+          # Xpath 1.0 does not support escape characters.


Suggested change

# Xpath 1.0 does not support escape characters.

# XPath 1.0 does not support escape characters.

kou · 2023-05-26T05:22:57Z

lib/rexml/parsers/xpathparser.rb

+          pattern = literal.include?('"') ? "'%s'" : '"%s"'
+          pattern % literal


Could you use string interpolation instead of String#%?

Suggested change

pattern = literal.include?('"') ? "'%s'" : '"%s"'

pattern % literal

if literal.include?("'")

"\"#{literal}\""

else

"'#{literal}'"

end

* Rename QuoteLiteral -> quote_literal and move to after predicate_to_string. * Xpath -> XPath. * Replace %-substitution w/ String "#{...}".

pulver · 2023-05-26T10:34:21Z

Done, thanks for the feedback.

kou · 2023-05-26T13:12:16Z

lib/rexml/parsers/xpathparser.rb

+        end
+      end
+
      private


Could you move this private above quote_literal?

Done: d6a02b9

pulver mentioned this pull request May 25, 2023

Inverse to XPathParser::parse? #95

Closed

kou reviewed May 25, 2023

View reviewed changes

Add XPathParser#QuoteLiteral.

b32affc

kou reviewed May 26, 2023

View reviewed changes

PR Feedback.

d50d7f3

* Rename QuoteLiteral -> quote_literal and move to after predicate_to_string. * Xpath -> XPath. * Replace %-substitution w/ String "#{...}".

kou reviewed May 26, 2023

View reviewed changes

Make quote_literal private.

d6a02b9

kou approved these changes May 26, 2023

View reviewed changes

kou changed the title ~~Add XPathParser#QuoteLiteral.~~ xpath abbreviate: add support for string literal that includes double quote May 26, 2023

kou changed the title ~~xpath abbreviate: add support for string literal that includes double quote~~ xpath abbreviate: add support for string literal that contains double-quote May 26, 2023

kou merged commit e08c52f into ruby:master May 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

xpath abbreviate: add support for string literal that contains double-quote#96

xpath abbreviate: add support for string literal that contains double-quote#96
kou merged 3 commits intoruby:masterfrom
pulver:master

pulver commented May 25, 2023 •

edited by kou

Loading

Uh oh!

kou left a comment

Uh oh!

pulver commented May 25, 2023

Uh oh!

kou May 26, 2023

Uh oh!

kou May 26, 2023

Uh oh!

kou May 26, 2023

Uh oh!

kou May 26, 2023

Uh oh!

pulver commented May 26, 2023

Uh oh!

kou May 26, 2023

Uh oh!

pulver May 26, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	# Xpath 1.0 does not support escape characters.
	# XPath 1.0 does not support escape characters.

		pattern = literal.include?('"') ? "'%s'" : '"%s"'
		pattern % literal

-          pattern = literal.include?('"') ? "'%s'" : '"%s"'
-          pattern % literal
+          if literal.include?("'")
+            "\"#{literal}\""
+          else
+            "'#{literal}'"
+          end

+                      end
+                    end
                     private

Conversation

pulver commented May 25, 2023 • edited by kou Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Output Before Change

Output After Change

Uh oh!

kou left a comment

Choose a reason for hiding this comment

Uh oh!

pulver commented May 25, 2023

Uh oh!

kou May 26, 2023

Choose a reason for hiding this comment

Uh oh!

kou May 26, 2023

Choose a reason for hiding this comment

Uh oh!

kou May 26, 2023

Choose a reason for hiding this comment

Uh oh!

kou May 26, 2023

Choose a reason for hiding this comment

Uh oh!

pulver commented May 26, 2023

Uh oh!

kou May 26, 2023

Choose a reason for hiding this comment

Uh oh!

pulver May 26, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

pulver commented May 25, 2023 •

edited by kou

Loading