net-imap 0.4.1 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bba73e8db611b37b7c5b9be540d99c2288e9188e7f12620259862b30db47815
-  data.tar.gz: fde1bcda99236beafea397d36768fb9fe185ec20ca2cd5d9c991b48cfdf51bd3
+  metadata.gz: da8cb634d9ee1613035c81a25d28ae9f36b3d0985bcb61da9a38aacb87854a5f
+  data.tar.gz: e504b145415da3a025c6f4ab973b212764c75ef4214d0fed485fdb0b17e83752
 SHA512:
-  metadata.gz: 6ee43fab9eaea8c870940e0cc625e3223722e4b722e1055da6f3629707aaf12e580143139abb97ae1294757a99db977428c8aa23bc57d8e9a23ff9ab5eb695cf
-  data.tar.gz: 67a965fdd6b4af0480917241a8efad57c3356c82ec975bcc10373242e477718a1751e78cc9f0e51286b553e6222c26cddca119dbaa9dfef855c9611de6a55a64
+  metadata.gz: 0cef39a5ac6454ded84c395fb2671df678e17611d7eff42665113c21f955ebcb6ffdf9035dd1e6fdb3de38aa38f43431537ded3d484ffba7d699b478bb8c3e1e
+  data.tar.gz: 23f777092b2940b725685285a6372b56744a9968fcc76872ebf9ef3136fb3665a89a85174dc34636e547b90d8d3a1945627ce79390f10122aadb57b57004f789

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /Gemfile.lock
+benchmarks/Gemfile*

data/Gemfile

@@ -8,3 +8,5 @@ gem "rake"
 gem "rdoc"
 gem "test-unit"
 gem "test-unit-ruby-core", git: "https://github.com/ruby/test-unit-ruby-core"
+
+gem "benchmark-driver"

data/lib/net/imap/errors.rb

@@ -47,7 +47,27 @@ module Net
     class ByeResponseError < ResponseError
     end
 
+    # Error raised when the server sends an invalid response.
+    #
+    # This is different from UnknownResponseError: the response has been
+    # rejected.  Although it may be parsable, the server is forbidden from
+    # sending it in the current context.  The client should automatically
+    # disconnect, abruptly (without logout).
+    #
+    # Note that InvalidResponseError does not inherit from ResponseError: it
+    # can be raised before the response is fully parsed.  A related
+    # ResponseParseError or ResponseError may be the #cause.
+    class InvalidResponseError < Error
+    end
+
     # Error raised upon an unknown response from the server.
+    #
+    # This is different from InvalidResponseError: the response may be a
+    # valid extension response and the server may be allowed to send it in
+    # this context, but Net::IMAP either does not know how to parse it or
+    # how to handle it.  This could result from enabling unknown or
+    # unhandled extensions.  The connection may still be usable,
+    # but—depending on context—it may be prudent to disconnect.
     class UnknownResponseError < ResponseError
     end
 

data/lib/net/imap/response_data.rb

@@ -55,17 +55,54 @@ module Net
 
     # Net::IMAP::IgnoredResponse represents intentionally ignored responses.
     #
-    # This includes untagged response "NOOP" sent by eg. Zimbra to avoid some
-    # clients to close the connection.
+    # This includes untagged response "NOOP" sent by eg. Zimbra to avoid
+    # some clients to close the connection.
     #
     # It matches no IMAP standard.
+    class IgnoredResponse < UntaggedResponse
+    end
+
+    # **Note:** This represents an intentionally _unstable_ API.  Where
+    # instances of this class are returned, future releases may return a
+    # different (incompatible) object <em>without deprecation or warning</em>.
+    #
+    # Net::IMAP::UnparsedData represents data for unknown response types or
+    # unknown extensions to response types without a well-defined extension
+    # grammar.
     #
-    class IgnoredResponse < Struct.new(:raw_data)
+    # See also: UnparsedNumericResponseData
+    class UnparsedData < Struct.new(:unparsed_data)
       ##
-      # method: raw_data
-      # :call-seq: raw_data -> string
+      # method: unparsed_data
+      # :call-seq: unparsed_data -> string
       #
-      # The raw response data.
+      # The unparsed data
+    end
+
+    # **Note:** This represents an intentionally _unstable_ API.  Where
+    # instances of this class are returned, future releases may return a
+    # different (incompatible) object <em>without deprecation or warning</em>.
+    #
+    # Net::IMAP::UnparsedNumericResponseData represents data for unhandled
+    # response types with a numeric prefix.  See the documentation for #number.
+    #
+    # See also: UnparsedData
+    class UnparsedNumericResponseData < Struct.new(:number, :unparsed_data)
+      ##
+      # method: number
+      # :call-seq: number -> integer
+      #
+      # Returns a numeric response data prefix, when available.
+      #
+      # Many response types are prefixed with a non-negative #number.  For
+      # message data, #number may represent a sequence number or a UID.  For
+      # mailbox data, #number may represent a message count.
+
+      ##
+      # method: unparsed_data
+      # :call-seq: unparsed_data -> string
+      #
+      # The unparsed data, not including #number or UntaggedResponse#name.
     end
 
     # Net::IMAP::TaggedResponse represents tagged responses.
@@ -108,6 +145,9 @@ module Net
     # UntaggedResponse#data when the response type is a "condition" ("OK", "NO",
     # "BAD", "PREAUTH", or "BYE").
     class ResponseText < Struct.new(:code, :text)
+      # Used to avoid an allocation when ResponseText is empty
+      EMPTY = new(nil, "").freeze
+
       ##
       # method: code
       # :call-seq: code -> ResponseCode or nil

data/lib/net/imap/response_parser/parser_utils.rb

@@ -15,6 +15,7 @@ module Net
 
           # we can skip lexer for single character matches, as a shortcut
           def def_char_matchers(name, char, token)
+            byte = char.ord
             match_name = name.match(/\A[A-Z]/) ? "#{name}!" : name
             char = char.dump
             class_eval <<~RUBY, __FILE__, __LINE__ + 1
@@ -27,7 +28,7 @@ module Net
 
               # use token or string peek
               def peek_#{name}?
-                @token ? @token.symbol == #{token} : @str[@pos] == #{char}
+                @token ? @token.symbol == #{token} : @str.getbyte(@pos) == #{byte}
               end
 
               # like accept(token_symbols); returns token or nil
@@ -35,7 +36,7 @@ module Net
                 if @token&.symbol == #{token}
                   #{SHIFT_TOKEN}
                   #{char}
-                elsif !@token && @str[@pos] == #{char}
+                elsif !@token && @str.getbyte(@pos) == #{byte}
                   @pos += 1
                   #{char}
                 end
@@ -46,7 +47,7 @@ module Net
                 if @token&.symbol == #{token}
                   #{SHIFT_TOKEN}
                   #{char}
-                elsif !@token && @str[@pos] == #{char}
+                elsif !@token && @str.getbyte(@pos) == #{byte}
                   @pos += 1
                   #{char}
                 else
@@ -109,7 +110,6 @@ module Net
                 end
               end
             RUBY
-
           end
 
         end
@@ -170,6 +170,16 @@ module Net
           @token ||= next_token
         end
 
+        # like match, without consuming the token
+        def lookahead!(*args)
+          if args.include?((@token ||= next_token)&.symbol)
+            @token
+          else
+            parse_error('unexpected token %s (expected %s)',
+                        @token&.symbol, args.join(" or "))
+          end
+        end
+
         def peek_str?(str)
           assert_no_lookahead if Net::IMAP.debug
           @str[@pos, str.length] == str