🔀 Merge pull request #203 from ruby/parser/rewrite-response_data

♻️ Refactor `response-data` methods to match ABNF

Author: nevans

lib/net/imap/response_parser.rb

@@ -383,15 +383,20 @@ def label(word)
         parse_error("unexpected atom %p, expected %p instead", val, word)
       end
 
+      # expects "OK" or "PREAUTH" and raises InvalidResponseError on failure
+      def resp_cond_auth__name
+        lbl = tagged_ext_label and AUTH_CONDS.include? lbl and return lbl
+        raise InvalidResponseError, "bad response type %p, expected %s" % [
+          lbl, AUTH_CONDS.join(" or ")
+        ]
+      end
+
       # expects "OK" or "NO" or "BAD" and raises InvalidResponseError on failure
       def resp_cond_state__name
-        if RESP_COND_STATES.include?(actual = tagged_ext_label)
-          actual
-        else
-          raise InvalidResponseError, "bad response type %p, expected %s" % [
-            actual, RESP_COND_STATES.join(" or ")
-          ]
-        end
+        lbl = tagged_ext_label and RESP_COND_STATES.include? lbl and return lbl
+        raise InvalidResponseError, "bad response type %p, expected %s" % [
+          lbl, RESP_COND_STATES.join(" or ")
+        ]
       end
 
       #   nstring         = string / nil
@@ -487,45 +492,45 @@ def response_data
         STAR!; SP!
         m = peek_re(RE_RESPONSE_TYPE) or parse_error("unparsable response")
         case m["type"].upcase
-        when "OK"         then response_cond             # RFC3501, RFC9051
+        when "OK"         then resp_cond_state__untagged # RFC3501, RFC9051
         when "FETCH"      then message_data__fetch       # RFC3501, RFC9051
         when "EXPUNGE"    then message_data__expunge     # RFC3501, RFC9051
         when "EXISTS"     then mailbox_data__exists      # RFC3501, RFC9051
         when "ESEARCH"    then esearch_response          # RFC4731, RFC9051, etc
         when "VANISHED"   then expunged_resp             # RFC7162
         when "UIDFETCH"   then uidfetch_resp             # (draft) UIDONLY
-        when "SEARCH"     then search_response           # RFC3501 (obsolete)
+        when "SEARCH"     then mailbox_data__search      # RFC3501 (obsolete)
         when "CAPABILITY" then capability_data__untagged # RFC3501, RFC9051
-        when "FLAGS"      then flags_response            # RFC3501, RFC9051
-        when "LIST"       then list_response             # RFC3501, RFC9051
-        when "STATUS"     then status_response           # RFC3501, RFC9051
+        when "FLAGS"      then mailbox_data__flags       # RFC3501, RFC9051
+        when "LIST"       then mailbox_data__list        # RFC3501, RFC9051
+        when "STATUS"     then mailbox_data__status      # RFC3501, RFC9051
         when "NAMESPACE"  then namespace_response        # RFC2342, RFC9051
         when "ENABLED"    then enable_data               # RFC5161, RFC9051
-        when "BAD"        then response_cond             # RFC3501, RFC9051
-        when "NO"         then response_cond             # RFC3501, RFC9051
-        when "PREAUTH"    then response_cond             # RFC3501, RFC9051
-        when "BYE"        then response_cond             # RFC3501, RFC9051
+        when "BAD"        then resp_cond_state__untagged # RFC3501, RFC9051
+        when "NO"         then resp_cond_state__untagged # RFC3501, RFC9051
+        when "PREAUTH"    then resp_cond_auth            # RFC3501, RFC9051
+        when "BYE"        then resp_cond_bye             # RFC3501, RFC9051
         when "RECENT"     then mailbox_data__recent      # RFC3501 (obsolete)
         when "SORT"       then sort_data                 # RFC5256, RFC7162
-        when "THREAD"     then thread_response           # RFC5256
-        when "QUOTA"      then getquota_response         # RFC2087, RFC9208
-        when "QUOTAROOT"  then getquotaroot_response     # RFC2087, RFC9208
+        when "THREAD"     then thread_data               # RFC5256
+        when "QUOTA"      then quota_response            # RFC2087, RFC9208
+        when "QUOTAROOT"  then quotaroot_response        # RFC2087, RFC9208
         when "ID"         then id_response               # RFC2971
-        when "ACL"        then getacl_response           # RFC4314
+        when "ACL"        then acl_data                  # RFC4314
         when "LISTRIGHTS" then listrights_data           # RFC4314
         when "MYRIGHTS"   then myrights_data             # RFC4314
         when "METADATA"   then metadata_resp             # RFC5464
         when "LANGUAGE"   then language_data             # RFC5255
         when "COMPARATOR" then comparator_data           # RFC5255
         when "CONVERTED"  then message_data__converted   # RFC5259
-        when "LSUB"       then list_response             # RFC3501 (obsolete)
-        when "XLIST"      then list_response             # deprecated
-        when "NOOP"       then ignored_response
-        else                   unparsed_response
+        when "LSUB"       then mailbox_data__lsub        # RFC3501 (obsolete)
+        when "XLIST"      then mailbox_data__xlist       # deprecated
+        when "NOOP"       then response_data__noop
+        else                   response_data__unhandled
         end
       end
 
-      def unparsed_response(klass = UntaggedResponse)
+      def response_data__unhandled(klass = UntaggedResponse)
         num  = number?;          SP?
         type = tagged_ext_label; SP?
         text = remaining_unparsed
@@ -539,17 +544,18 @@ def remaining_unparsed
         str&.empty? ? nil : str
       end
 
-      def ignored_response; unparsed_response(IgnoredResponse) end
+      def response_data__ignored; response_data__unhandled(IgnoredResponse) end
+      alias response_data__noop     response_data__ignored
 
-      alias esearch_response        unparsed_response
-      alias expunged_resp           unparsed_response
-      alias uidfetch_resp           unparsed_response
-      alias listrights_data         unparsed_response
-      alias myrights_data           unparsed_response
-      alias metadata_resp           unparsed_response
-      alias language_data           unparsed_response
-      alias comparator_data         unparsed_response
-      alias message_data__converted unparsed_response
+      alias esearch_response        response_data__unhandled
+      alias expunged_resp           response_data__unhandled
+      alias uidfetch_resp           response_data__unhandled
+      alias listrights_data         response_data__unhandled
+      alias myrights_data           response_data__unhandled
+      alias metadata_resp           response_data__unhandled
+      alias language_data           response_data__unhandled
+      alias comparator_data         response_data__unhandled
+      alias message_data__converted response_data__unhandled
 
       # RFC3501 & RFC9051:
       #   response-tagged = tag SP resp-cond-state CRLF
@@ -561,15 +567,26 @@ def ignored_response; unparsed_response(IgnoredResponse) end
       def response_tagged
         tag  = tag();                 SP!
         name = resp_cond_state__name; SP!
-        data = resp_text
-        TaggedResponse.new(tag, name, data, @str)
+        TaggedResponse.new(tag, name, resp_text, @str)
       end
 
-      def response_cond
-        token = match(T_ATOM)
-        name = token.value.upcase
-        match(T_SPACE)
-        return UntaggedResponse.new(name, resp_text, @str)
+      # RFC3501 & RFC9051:
+      #   resp-cond-state  = ("OK" / "NO" / "BAD") SP resp-text
+      def resp_cond_state__untagged
+        name = resp_cond_state__name; SP!
+        UntaggedResponse.new(name, resp_text, @str)
+      end
+
+      #   resp-cond-auth   = ("OK" / "PREAUTH") SP resp-text
+      def resp_cond_auth
+        name = resp_cond_auth__name; SP!
+        UntaggedResponse.new(name, resp_text, @str)
+      end
+
+      #   resp-cond-bye    = "BYE" SP resp-text
+      def resp_cond_bye
+        name = label(BYE); SP!
+        UntaggedResponse.new(name, resp_text, @str)
       end
 
       #   message-data    = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
@@ -1046,19 +1063,21 @@ def modseq_data
         return name, modseq
       end
 
-      def flags_response
+      def mailbox_data__flags
         token = match(T_ATOM)
         name = token.value.upcase
         match(T_SPACE)
         return UntaggedResponse.new(name, flag_list, @str)
       end
 
-      def list_response
+      def mailbox_data__list
         token = match(T_ATOM)
         name = token.value.upcase
         match(T_SPACE)
         return UntaggedResponse.new(name, mailbox_list, @str)
       end
+      alias mailbox_data__lsub  mailbox_data__list
+      alias mailbox_data__xlist mailbox_data__list
 
       def mailbox_list
         attr = flag_list
@@ -1124,7 +1143,8 @@ def getquotaroot_response
         return UntaggedResponse.new(name, data, @str)
       end
 
-      def getacl_response
+      # acl-data        = "ACL" SP mailbox *(SP identifier SP rights)
+      def acl_data
         token = match(T_ATOM)
         name = token.value.upcase
         match(T_SPACE)
@@ -1150,7 +1170,21 @@ def getacl_response
         return UntaggedResponse.new(name, data, @str)
       end
 
-      def search_response
+      # RFC3501:
+      #   mailbox-data        = "SEARCH" *(SP nz-number) / ...
+      # RFC5256: SORT
+      #   sort-data           = "SORT" *(SP nz-number)
+      # RFC7162: CONDSTORE, QRESYNC
+      #   mailbox-data        =/ "SEARCH" [1*(SP nz-number) SP
+      #                          search-sort-mod-seq]
+      #   sort-data           = "SORT" [1*(SP nz-number) SP
+      #                           search-sort-mod-seq]
+      #                           ; Updates the SORT response from RFC 5256.
+      #   search-sort-mod-seq = "(" "MODSEQ" SP mod-sequence-value ")"
+      # RFC9051:
+      #   mailbox-data        = obsolete-search-response / ...
+      #   obsolete-search-response = "SEARCH" *(SP nz-number)
+      def mailbox_data__search
         token = match(T_ATOM)
         name = token.value.upcase
         token = lookahead
@@ -1180,8 +1214,9 @@ def search_response
         end
         return UntaggedResponse.new(name, data, @str)
       end
+      alias sort_data mailbox_data__search
 
-      def thread_response
+      def thread_data
         token = match(T_ATOM)
         name = token.value.upcase
         token = lookahead
@@ -1243,7 +1278,7 @@ def thread_branch(token)
         return rootmember
       end
 
-      def status_response
+      def mailbox_data__status
         token = match(T_ATOM)
         name = token.value.upcase
         match(T_SPACE)