Message less confusing error to human (#16)

ujihisa · kou · commit f6528d447752 · 2019-02-21T17:42:08.000+09:00
* Message less confusing error to human

* Problem: Following error message is not helpful, because you have to reason
  that '' actually means it's in the top-level, and the 'div' (not '&lt;/div&gt;') is
  an end tag

        require "rexml/parsers/lightparser"
        REXML::Parsers::LightParser.new('&lt;/div&gt;').parse
        #=&gt; Missing end tag for '' (got 'div')

* Solution: add a special case in error handling just to change the error message

        require "rexml/parsers/lightparser"
        REXML::Parsers::LightParser.new('&lt;/div&gt;').parse
        #=&gt; Unexpected top-level end tag (got 'div')

* Refactor by removing unnecessary `md` check

* Thanks @a_matsuda to review this at asakusa.rb!
diff --git a/lib/rexml/parsers/baseparser.rb b/lib/rexml/parsers/baseparser.rb
@@ -335,6 +335,10 @@ def pull_event
               @nsstack.shift
               last_tag = @tags.pop
               md = @source.match( CLOSE_MATCH, true )
+              if md and !last_tag
+                message = "Unexpected top-level end tag (got '#{md[1]}')"
+                raise REXML::ParseException.new(message, @source)
+              end
               if md.nil? or last_tag != md[1]
                 message = "Missing end tag for '#{last_tag}'"
                 message << " (got '#{md[1]}')" if md
diff --git a/test/rexml/parse/test_element.rb b/test/rexml/parse/test_element.rb
@@ -8,6 +8,19 @@ def parse(xml)
     end
 
     class TestInvalid < self
+      def test_top_level_end_tag
+        exception = assert_raise(REXML::ParseException) do
+          parse("</a>")
+        end
+        assert_equal(<<-DETAIL.chomp, exception.to_s)
+Unexpected top-level end tag (got 'a')
+Line: 1
+Position: 4
+Last 80 unconsumed characters:
+
+        DETAIL
+      end
+
       def test_no_end_tag
         exception = assert_raise(REXML::ParseException) do
           parse("<a></")
