net-imap 0.5.12 → 0.6.0

data/lib/net/imap/uidplus_data.rb

@@ -3,69 +3,8 @@
 module Net
   class IMAP < Protocol
 
-    # *NOTE:* <em>UIDPlusData is deprecated and will be removed in the +0.6.0+
-    # release.</em>  To use AppendUIDData and CopyUIDData before +0.6.0+, set
-    # Config#parser_use_deprecated_uidplus_data to +false+.
-    #
-    # UIDPlusData represents the ResponseCode#data that accompanies the
-    # +APPENDUID+ and +COPYUID+ {response codes}[rdoc-ref:ResponseCode].
-    #
-    # A server that supports +UIDPLUS+ should send UIDPlusData in response to
-    # the append[rdoc-ref:Net::IMAP#append], copy[rdoc-ref:Net::IMAP#copy],
-    # move[rdoc-ref:Net::IMAP#move], {uid copy}[rdoc-ref:Net::IMAP#uid_copy],
-    # and {uid move}[rdoc-ref:Net::IMAP#uid_move] commands---unless the
-    # destination mailbox reports +UIDNOTSTICKY+.
-    #
-    # Note that append[rdoc-ref:Net::IMAP#append], copy[rdoc-ref:Net::IMAP#copy]
-    # and {uid_copy}[rdoc-ref:Net::IMAP#uid_copy] return UIDPlusData in their
-    # TaggedResponse.  But move[rdoc-ref:Net::IMAP#copy] and
-    # {uid_move}[rdoc-ref:Net::IMAP#uid_move] _should_ send UIDPlusData in an
-    # UntaggedResponse response before sending their TaggedResponse.  However
-    # some servers do send UIDPlusData in the TaggedResponse for +MOVE+
-    # commands---this complies with the older +UIDPLUS+ specification but is
-    # discouraged by the +MOVE+ extension and disallowed by +IMAP4rev2+.
-    #
-    # == Required capability
-    # Requires either +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315]]
-    # or +IMAP4rev2+ capability.
-    #
-    class UIDPlusData < Struct.new(:uidvalidity, :source_uids, :assigned_uids)
-      ##
-      # method: uidvalidity
-      # :call-seq: uidvalidity -> nonzero uint32
-      #
-      # The UIDVALIDITY of the destination mailbox.
-
-      ##
-      # method: source_uids
-      # :call-seq: source_uids -> nil or an array of nonzero uint32
-      #
-      # The UIDs of the copied or moved messages.
-      #
-      # Note:: Returns +nil+ for Net::IMAP#append.
-
-      ##
-      # method: assigned_uids
-      # :call-seq: assigned_uids -> an array of nonzero uint32
-      #
-      # The newly assigned UIDs of the copied, moved, or appended messages.
-      #
-      # Note:: This always returns an array, even when it contains only one UID.
-
-      ##
-      # :call-seq: uid_mapping -> nil or a hash
-      #
-      # Returns a hash mapping each source UID to the newly assigned destination
-      # UID.
-      #
-      # Note:: Returns +nil+ for Net::IMAP#append.
-      def uid_mapping
-        source_uids&.zip(assigned_uids)&.to_h
-      end
-    end
-
     # >>>
-    #   *NOTE:* <em>AppendUIDData will replace UIDPlusData for +APPENDUID+ in the
+    #   *NOTE:* <em>AppendUIDData replaced UIDPlusData for +APPENDUID+ in the
     #   +0.6.0+ release.</em>  To use AppendUIDData before +0.6.0+, set
     #   Config#parser_use_deprecated_uidplus_data to +false+.
     #
@@ -109,7 +48,7 @@ module Net
     end
 
     # >>>
-    #   *NOTE:* <em>CopyUIDData will replace UIDPlusData for +COPYUID+ in the
+    #   *NOTE:* <em>CopyUIDData replaced UIDPlusData for +COPYUID+ in the
     #   +0.6.0+ release.</em>  To use CopyUIDData before +0.6.0+, set
     #   Config#parser_use_deprecated_uidplus_data to +false+.
     #

data/lib/net/imap.rb

@@ -359,8 +359,8 @@ module Net
   #
   # - #capability: Returns the server's capabilities as an array of strings.
   #
-  #   <em>In general, #capable? should be used rather than explicitly sending a
-  #   +CAPABILITY+ command to the server.</em>
+  #   <em>In general,</em> #capable? <em>should be used rather than explicitly
+  #   sending a +CAPABILITY+ command to the server.</em>
   # - #noop: Allows the server to send unsolicited untagged #responses.
   # - #logout: Tells the server to end the session. Enters the +logout+ state.
   #
@@ -788,7 +788,7 @@ module Net
   # * {IMAP URLAUTH Authorization Mechanism Registry}[https://www.iana.org/assignments/urlauth-authorization-mechanism-registry/urlauth-authorization-mechanism-registry.xhtml]
   #
   class IMAP < Protocol
-    VERSION = "0.5.12"
+    VERSION = "0.6.0"
 
     # Aliases for supported capabilities, to be used with the #enable command.
     ENABLE_ALIASES = {
@@ -805,10 +805,6 @@ module Net
     autoload :StringPrep,             "#{dir}/stringprep"
 
     include MonitorMixin
-    if defined?(OpenSSL::SSL)
-      include OpenSSL
-      include SSL
-    end
 
     # :call-seq:
     #   Net::IMAP::SequenceSet(set = nil) -> SequenceSet
@@ -1522,6 +1518,7 @@ module Net
     # completes.  If the TaggedResponse to #authenticate includes updated
     # capabilities, they will be cached.
     def authenticate(*args, sasl_ir: config.sasl_ir, **props, &callback)
+      sasl_ir = may_depend_on_capabilities_cached?(sasl_ir)
       sasl_adapter.authenticate(*args, sasl_ir: sasl_ir, **props, &callback)
         .tap do state_authenticated! _1 end
     end
@@ -1573,7 +1570,7 @@ module Net
     # When the +condstore+ keyword argument is true, the server is told to
     # enable the extension.  If +mailbox+ supports persistence of mod-sequences,
     # the +HIGHESTMODSEQ+ ResponseCode will be sent as an untagged response to
-    # #select and all `FETCH` responses will include FetchData#modseq.
+    # #select and all +FETCH+ responses will include FetchData#modseq.
     # Otherwise, the +NOMODSEQ+ ResponseCode will be sent.
     #
     # A Net::IMAP::NoResponseError is raised if the mailbox does not
@@ -2024,7 +2021,7 @@ module Net
     #
     # If +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315.html]] is
     # supported and the destination supports persistent UIDs, the server's
-    # response should include an +APPENDUID+ response code with UIDPlusData.
+    # response should include an +APPENDUID+ response code with AppendUIDData.
     # This will report the UIDVALIDITY of the destination mailbox and the
     # assigned UID of the appended message.
     #
@@ -2675,6 +2672,7 @@ module Net
     #     # fetch should return quickly and allocate little memory
     #     results.size # => 0..500
     #     break if results.empty?
+    #     results.sort_by!(&:uid) # server may return results out of order
     #     next_uid_to_fetch = results.last.uid + 1
     #     process results
     #   end
@@ -2780,7 +2778,7 @@ module Net
     #
     # If +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315.html]] is
     # supported, the server's response should include a +COPYUID+ response code
-    # with UIDPlusData.  This will report the UIDVALIDITY of the destination
+    # with CopyUIDData.  This will report the UIDVALIDITY of the destination
     # mailbox, the UID set of the source messages, and the assigned UID set of
     # the moved messages.
     #
@@ -2821,7 +2819,7 @@ module Net
     #
     # If +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315.html]] is
     # supported, the server's response should include a +COPYUID+ response code
-    # with UIDPlusData.  This will report the UIDVALIDITY of the destination
+    # with CopyUIDData.  This will report the UIDVALIDITY of the destination
     # mailbox, the UID set of the source messages, and the assigned UID set of
     # the moved messages.
     #
@@ -3581,11 +3579,11 @@ module Net
     end
 
     def enforce_logindisabled?
-      if config.enforce_logindisabled == :when_capabilities_cached
-        capabilities_cached?
-      else
-        config.enforce_logindisabled
-      end
+      may_depend_on_capabilities_cached?(config.enforce_logindisabled)
+    end
+
+    def may_depend_on_capabilities_cached?(value)
+      value == :when_capabilities_cached ? capabilities_cached? : value
     end
 
     def expunge_internal(...)
@@ -3781,11 +3779,8 @@ module Net
     def build_ssl_ctx(ssl)
       if ssl
         params = (Hash.try_convert(ssl) || {}).freeze
-        context = SSLContext.new
+        context = OpenSSL::SSL::SSLContext.new
         context.set_params(params)
-        if defined?(VerifyCallbackProc)
-          context.verify_callback = VerifyCallbackProc
-        end
         context.freeze
         [params, context]
       else
@@ -3797,12 +3792,12 @@ module Net
       raise "SSL extension not installed" unless defined?(OpenSSL::SSL)
       raise "already using SSL" if @sock.kind_of?(OpenSSL::SSL::SSLSocket)
       raise "cannot start TLS without SSLContext" unless ssl_ctx
-      @sock = SSLSocket.new(@sock, ssl_ctx)
+      @sock = OpenSSL::SSL::SSLSocket.new(@sock, ssl_ctx)
       @reader = ResponseReader.new(self, @sock)
       @sock.sync_close = true
       @sock.hostname = @host if @sock.respond_to? :hostname=
       ssl_socket_connect(@sock, open_timeout)
-      if ssl_ctx.verify_mode != VERIFY_NONE
+      if ssl_ctx.verify_mode != OpenSSL::SSL::VERIFY_NONE
         @sock.post_connection_check(@host)
         @tls_verified = true
       end
@@ -3866,7 +3861,6 @@ require_relative "imap/errors"
 require_relative "imap/config"
 require_relative "imap/command_data"
 require_relative "imap/data_encoding"
-require_relative "imap/data_lite"
 require_relative "imap/flags"
 require_relative "imap/response_data"
 require_relative "imap/response_parser"

data/net-imap.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Ruby client api for Internet Message Access Protocol}
   spec.description   = %q{Ruby client api for Internet Message Access Protocol}
   spec.homepage      = "https://github.com/ruby/net-imap"
-  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.2.0")
   spec.licenses       = ["Ruby", "BSD-2-Clause"]
 
   spec.metadata["homepage_uri"] = spec.homepage

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-imap
 version: !ruby/object:Gem::Version
-  version: 0.5.12
+  version: 0.6.0
 platform: ruby
 authors:
 - Shugo Maeda
@@ -60,9 +60,9 @@ files:
 - lib/net/imap/config/attr_accessors.rb
 - lib/net/imap/config/attr_inheritance.rb
 - lib/net/imap/config/attr_type_coercion.rb
+- lib/net/imap/config/attr_version_defaults.rb
 - lib/net/imap/connection_state.rb
 - lib/net/imap/data_encoding.rb
-- lib/net/imap/data_lite.rb
 - lib/net/imap/deprecated_client_options.rb
 - lib/net/imap/errors.rb
 - lib/net/imap/esearch_result.rb
@@ -122,14 +122,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.1
 specification_version: 4
 summary: Ruby client api for Internet Message Access Protocol
 test_files: []

data/lib/net/imap/data_lite.rb

@@ -1,226 +0,0 @@
-# frozen_string_literal: true
-
-# Some of the code in this file was copied from the polyfill-data gem.
-#
-# MIT License
-#
-# Copyright (c) 2023 Jim Gay, Joel Drapper, Nicholas Evans
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-
-module Net
-  class IMAP
-    data_or_object = RUBY_VERSION >= "3.2.0" ? ::Data : Object
-    class DataLite < data_or_object
-      def encode_with(coder) coder.map = to_h.transform_keys(&:to_s)        end
-      def init_with(coder) initialize(**coder.map.transform_keys(&:to_sym)) end
-    end
-
-    Data = DataLite
-  end
-end
-
-# :nocov:
-# Need to skip test coverage for the rest, because it isn't loaded by ruby 3.2+.
-return if RUBY_VERSION >= "3.2.0"
-
-module Net
-  class IMAP
-    # DataLite is a temporary substitute for ruby 3.2's +Data+ class.  DataLite
-    # is aliased as Net::IMAP::Data, so that code using it won't need to be
-    # updated when it is removed.
-    #
-    # See {ruby 3.2's documentation for Data}[https://docs.ruby-lang.org/en/3.2/Data.html].
-    #
-    # [When running ruby 3.1]
-    #    This class reimplements the API for ruby 3.2's +Data+, and should be
-    #    compatible for nearly all use-cases.  This reimplementation <em>will be
-    #    removed</em> in +net-imap+ 0.6, when support for ruby 3.1 is dropped.
-    #
-    #    _NOTE:_ +net-imap+ no longer supports ruby versions prior to 3.1.
-    # [When running ruby >= 3.2]
-    #    This class inherits from +Data+ and _only_ defines the methods needed
-    #    for YAML serialization.  This will be dropped when +psych+ adds support
-    #    for +Data+.
-    #
-    # Some of the code in this class was copied or adapted from the
-    # {polyfill-data gem}[https://rubygems.org/gems/polyfill-data], by Jim Gay
-    # and Joel Drapper, under the MIT license terms.
-    class DataLite
-      singleton_class.undef_method :new
-
-      TYPE_ERROR    = "%p is not a symbol nor a string"
-      ATTRSET_ERROR = "invalid data member: %p"
-      DUP_ERROR     = "duplicate member: %p"
-      ARITY_ERROR   = "wrong number of arguments (given %d, expected %s)"
-      private_constant :TYPE_ERROR, :ATTRSET_ERROR, :DUP_ERROR, :ARITY_ERROR
-
-      # Defines a new Data class.
-      #
-      # _NOTE:_ Unlike ruby 3.2's +Data.define+, DataLite.define only supports
-      # member names which are valid local variable names.  Member names can't
-      # be keywords (e.g: +next+ or +class+) or start with capital letters, "@",
-      # etc.
-      def self.define(*args, &block)
-        members = args.each_with_object({}) do |arg, members|
-          arg = arg.to_str unless arg in Symbol | String if arg.respond_to?(:to_str)
-          arg = arg.to_sym if     arg in String
-          arg in Symbol     or  raise TypeError,     TYPE_ERROR    % [arg]
-          arg in %r{=}      and raise ArgumentError, ATTRSET_ERROR % [arg]
-          members.key?(arg) and raise ArgumentError, DUP_ERROR     % [arg]
-          members[arg] = true
-        end
-        members = members.keys.freeze
-
-        klass = ::Class.new(self)
-
-        klass.singleton_class.undef_method :define
-        klass.define_singleton_method(:members) { members }
-
-        def klass.new(*args, **kwargs, &block)
-          if kwargs.size.positive?
-            if args.size.positive?
-              raise ArgumentError, ARITY_ERROR % [args.size, 0]
-            end
-          elsif members.size < args.size
-            expected = members.size.zero? ? 0 : 0..members.size
-            raise ArgumentError, ARITY_ERROR % [args.size, expected]
-          else
-            kwargs = Hash[members.take(args.size).zip(args)]
-          end
-          allocate.tap do |instance|
-            instance.__send__(:initialize, **kwargs, &block)
-          end.freeze
-        end
-
-        klass.singleton_class.alias_method :[], :new
-        klass.attr_reader(*members)
-
-        # Dynamically defined initializer methods are in an included module,
-        # rather than directly on DataLite (like in ruby 3.2+):
-        # * simpler to handle required kwarg ArgumentErrors
-        # * easier to ensure consistent ivar assignment order (object shape)
-        # * faster than instance_variable_set
-        klass.include(Module.new do
-          if members.any?
-            kwargs = members.map{"#{_1.name}:"}.join(", ")
-            params = members.map(&:name).join(", ")
-            ivars  = members.map{"@#{_1.name}"}.join(", ")
-            attrs  = members.map{"attrs[:#{_1.name}]"}.join(", ")
-            module_eval <<~RUBY, __FILE__, __LINE__ + 1
-              protected
-              def initialize(#{kwargs}) #{ivars} = #{params}; freeze end
-              def marshal_load(attrs)   #{ivars} = #{attrs};  freeze end
-            RUBY
-          end
-        end)
-
-        klass.module_eval do _1.module_eval(&block) end if block_given?
-
-        klass
-      end
-
-      ##
-      # singleton-method: new
-      # call-seq:
-      #   new(*args) -> instance
-      #   new(**kwargs) -> instance
-      #
-      # Constuctor for classes defined with ::define.
-      #
-      # Aliased as ::[].
-
-      ##
-      # singleton-method: []
-      # call-seq:
-      #   ::[](*args) -> instance
-      #   ::[](**kwargs) -> instance
-      #
-      # Constuctor for classes defined with ::define.
-      #
-      # Alias for ::new
-
-      ##
-      def members;     self.class.members                              end
-      def to_h(&block) block ? __to_h__.to_h(&block) : __to_h__        end
-      def hash;        [self.class, __to_h__].hash                     end
-      def ==(other)    self.class == other.class && to_h == other.to_h end
-      def eql?(other)  self.class == other.class && hash == other.hash end
-      def deconstruct; __to_h__.values                                 end
-
-      def deconstruct_keys(keys)
-        raise TypeError unless keys.is_a?(Array) || keys.nil?
-        return __to_h__ if keys&.first.nil?
-        __to_h__.slice(*keys)
-      end
-
-      def with(**kwargs)
-        return self if kwargs.empty?
-        self.class.new(**__to_h__.merge(kwargs))
-      end
-
-      def inspect
-        __inspect_guard__(self) do |seen|
-          return "#<data #{self.class}:...>" if seen
-          attrs = __to_h__.map {|kv| "%s=%p" % kv }.join(", ")
-          display = ["data", self.class.name, attrs].compact.join(" ")
-          "#<#{display}>"
-        end
-      end
-      alias_method :to_s, :inspect
-
-      private
-
-      def initialize_copy(source) super.freeze end
-      def marshal_dump; __to_h__ end
-
-      def __to_h__; Hash[members.map {|m| [m, send(m)] }] end
-
-      # Yields +true+ if +obj+ has been seen already, +false+ if it hasn't.
-      # Marks +obj+ as seen inside the block, so circuler references don't
-      # recursively trigger a SystemStackError (stack level too deep).
-      #
-      # Making circular references inside a Data object _should_ be very
-      # uncommon, but we'll support them for the sake of completeness.
-      def __inspect_guard__(obj)
-        preexisting = Thread.current[:__net_imap_data__inspect__]
-        Thread.current[:__net_imap_data__inspect__] ||= {}.compare_by_identity
-        inspect_guard = Thread.current[:__net_imap_data__inspect__]
-        if inspect_guard.include?(obj)
-          yield true
-        else
-          begin
-            inspect_guard[obj] = true
-            yield false
-          ensure
-            inspect_guard.delete(obj)
-          end
-        end
-      ensure
-        unless preexisting.equal?(inspect_guard)
-          Thread.current[:__net_imap_data__inspect__] = preexisting
-        end
-      end
-
-    end
-
-  end
-end
-# :nocov: