net-imap 0.4.8 → 0.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b90ea893e6f831943d2d0412ff068c7a6603ce3bf723900ea7401a9e045f724b
-  data.tar.gz: '087c861278ce56a7369780aa27d77e56ed6d94907a4116a3a4fd9707f327d57a'
+  metadata.gz: 4748c4c7176f5267d0efbb4e6dcf4a1e4ffcbf236ac808d798937485b8b7e509
+  data.tar.gz: cdf7efa6adad2ebea59d19f0580d65581b3fc3ae2d23bb2394acf58dd809bd2b
 SHA512:
-  metadata.gz: 5fa157a8887d5ca2b97b75756b5414d5973667299ae3dbdb340b432eae05cfdb2994969ea2dab68b595f2eae66bd50d19fb814196fb991af1bfc285dfa5b3d6f
-  data.tar.gz: 7b173943ff66f97b5b22795752a34f7338228e6ef5a4dca43b293f5e3153f90d34b7039fd24c76399b1f460e77ffe422dd3691466b0952e3631f2406bab70854
+  metadata.gz: 241c1c908e0c59253d0a29779a1feeb8709cf25ab21be425d1e169783cad4b1feab7c5c4db79ed1ebdf658e9aab7b46e3ba53b79f381605ed96efe0b9497e9d7
+  data.tar.gz: 0d7e42911c110ef1530e94512ae720a9fd992aede9c406fd706fb553f11097cab6ee842aa3d63466effd4fda6255e23647a0dc8a964012738a44448a85d0a47c

data/.github/workflows/test.yml

@@ -26,6 +26,6 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
-        rubygems: latest
+        rubygems: 3.4.22
     - name: Run test
       run: bundle exec rake test

data/lib/net/imap/fetch_data.rb

@@ -131,8 +131,8 @@ module Net
       #
       # A transformation of #attr, with all the keys converted to upper case.
       #
-      # Header field names are case-preserved but not not case-sensitive, so
-      # this is used by #header_fields and #header_fields_not.
+      # Header field names are case-preserved but not case-sensitive, so this is
+      # used by #header_fields and #header_fields_not.
       def attr_upcase; attr.transform_keys(&:upcase) end
 
       # :call-seq:

data/lib/net/imap/response_parser.rb

@@ -1929,6 +1929,8 @@ module Net
         end
       end
 
+      # This allows illegal "]" in flag names (Gmail),
+      # or "\*" in a FLAGS response (greenmail).
       def quirky__flag_list(name)
         match_re(Patterns::QUIRKY_FLAGS_LIST, "quirks mode #{name}")[1]
           .scan(Patterns::QUIRKY_FLAG)

data/lib/net/imap/sequence_set.rb

@@ -60,6 +60,21 @@ module Net
     #     set = Net::IMAP::SequenceSet[1, 2, [3..7, 5], 6..10, 2048, 1024]
     #     set.valid_string  #=> "1:10,55,1024:2048"
     #
+    # == Normalized form
+    #
+    # When a sequence set is created with a single String value, that #string
+    # representation is preserved.  SequenceSet's internal representation
+    # implicitly sorts all entries, de-duplicates numbers, and coalesces
+    # adjacent or overlapping ranges.  Most enumeration methods and offset-based
+    # methods use this normalized representation.  Most modification methods
+    # will convert #string to its normalized form.
+    #
+    # In some cases the order of the string representation is significant, such
+    # as the +ESORT+, <tt>CONTEXT=SORT</tt>, and +UIDPLUS+ extensions.  Use
+    # #entries or #each_entry to enumerate the set in its original order.  To
+    # preserve #string order while modifying a set, use #append, #string=, or
+    # #replace.
+    #
     # == Using <tt>*</tt>
     #
     # \IMAP sequence sets may contain a special value <tt>"*"</tt>, which
@@ -151,7 +166,7 @@ module Net
     #   +nil+ if the object cannot be converted to a compatible type.
     # - #cover? (aliased as #===):
     #   Returns whether a given object is fully contained within +self+.
-    # - #intersect?:
+    # - #intersect? (aliased as #overlap?):
     #   Returns whether +self+ and a given object have any common elements.
     # - #disjoint?:
     #   Returns whether +self+ and a given object have no common elements.
@@ -186,10 +201,14 @@ module Net
     #
     # === Methods for Iterating
     #
-    # - #each_element: Yields each number and range in the set and returns
-    #   +self+.
-    # - #elements (aliased as #to_a):
-    #   Returns an Array of every number and range in the set.
+    # - #each_element: Yields each number and range in the set, sorted and
+    #   coalesced, and returns +self+.
+    # - #elements (aliased as #to_a): Returns an Array of every number and range
+    #   in the set, sorted and coalesced.
+    # - #each_entry: Yields each number and range in the set, unsorted and
+    #   without deduplicating numbers or coalescing ranges, and returns +self+.
+    # - #entries: Returns an Array of every number and range in the set,
+    #   unsorted and without deduplicating numbers or coalescing ranges.
     # - #each_range:
     #   Yields each element in the set as a Range and returns +self+.
     # - #ranges: Returns an Array of every element in the set, converting
@@ -222,6 +241,8 @@ module Net
     # - #add?: If the given object is not an element in the set, adds it and
     #   returns +self+; otherwise, returns +nil+.
     # - #merge: Merges multiple elements into the set; returns +self+.
+    # - #append: Adds a given object to the set, appending it to the existing
+    #   string, and returns +self+.
     # - #string=: Assigns a new #string value and replaces #elements to match.
     # - #replace: Replaces the contents of the set with the contents
     #   of a given object.
@@ -502,6 +523,7 @@ module Net
       def intersect?(other)
         valid? && input_to_tuples(other).any? { intersect_tuple? _1 }
       end
+      alias overlap? intersect?
 
       # Returns +true+ if the set and a given object have no common elements,
       # +false+ otherwise.
@@ -655,6 +677,18 @@ module Net
       end
       alias << add
 
+      # Adds a range or number to the set and returns +self+.
+      #
+      # Unlike #add, #merge, or #union, the new value is appended to #string.
+      # This may result in a #string which has duplicates or is out-of-order.
+      def append(object)
+        tuple = input_to_tuple object
+        entry = tuple_to_str tuple
+        tuple_add tuple
+        @string = -(string ? "#{@string},#{entry}" : entry)
+        self
+      end
+
       # :call-seq: add?(object) -> self or nil
       #
       # Adds a range or number to the set and returns +self+.  Returns +nil+
@@ -787,7 +821,18 @@ module Net
         normalize!
       end
 
-      # Returns an array of ranges and integers.
+      # Returns an array of ranges and integers and <tt>:*</tt>.
+      #
+      # The entries are in the same order they appear in #string, with no
+      # sorting, deduplication, or coalescing.  When #string is in its
+      # normalized form, this will return the same result as #elements.
+      # This is useful when the given order is significant, for example in a
+      # ESEARCH response to IMAP#sort.
+      #
+      # Related: #each_entry, #elements
+      def entries; each_entry.to_a end
+
+      # Returns an array of ranges and integers and <tt>:*</tt>.
       #
       # The returned elements are sorted and coalesced, even when the input
       # #string is not.  <tt>*</tt> will sort last.  See #normalize.
@@ -854,22 +899,42 @@ module Net
       # Related: #elements, #ranges, #to_set
       def numbers; each_number.to_a end
 
-      # Yields each number or range in #elements to the block and returns self.
+      # Yields each number or range in #string to the block and returns +self+.
       # Returns an enumerator when called without a block.
       #
-      # Related: #elements
+      # The entries are yielded in the same order they appear in #tring, with no
+      # sorting, deduplication, or coalescing.  When #string is in its
+      # normalized form, this will yield the same values as #each_element.
+      #
+      # Related: #entries, #each_element
+      def each_entry(&block)
+        return to_enum(__method__) unless block_given?
+        return each_element(&block) unless @string
+        @string.split(",").each do yield tuple_to_entry str_to_tuple _1 end
+        self
+      end
+
+      # Yields each number or range (or <tt>:*</tt>) in #elements to the block
+      # and returns self.  Returns an enumerator when called without a block.
+      #
+      # The returned numbers are sorted and de-duplicated, even when the input
+      # #string is not.  See #normalize.
+      #
+      # Related: #elements, #each_entry
       def each_element # :yields: integer or range or :*
         return to_enum(__method__) unless block_given?
-        @tuples.each do |min, max|
-          if    min == STAR_INT then yield :*
-          elsif max == STAR_INT then yield min..
-          elsif min == max      then yield min
-          else                       yield min..max
-          end
-        end
+        @tuples.each do yield tuple_to_entry _1 end
         self
       end
 
+      private def tuple_to_entry((min, max))
+        if    min == STAR_INT then :*
+        elsif max == STAR_INT then min..
+        elsif min == max      then min
+        else                       min..max
+        end
+      end
+
       # Yields each range in #ranges to the block and returns self.
       # Returns an enumerator when called without a block.
       #

data/lib/net/imap.rb

@@ -717,7 +717,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.4.8"
+    VERSION = "0.4.9"
 
     # Aliases for supported capabilities, to be used with the #enable command.
     ENABLE_ALIASES = {
@@ -2883,7 +2883,6 @@ module Net
       else
         normalize_searching_criteria(search_keys)
       end
-      normalize_searching_criteria(search_keys)
       synchronize do
         send_command(cmd, sort_keys, charset, *search_keys)
         clear_responses("SORT").last || []
@@ -2896,7 +2895,6 @@ module Net
       else
         normalize_searching_criteria(search_keys)
       end
-      normalize_searching_criteria(search_keys)
       synchronize do
         send_command(cmd, algorithm, charset, *search_keys)
         clear_responses("THREAD").last || []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-imap
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.9
 platform: ruby
 authors:
 - Shugo Maeda
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2023-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-protocol