net-imap 0.4.1 → 0.4.4

data/lib/net/imap.rb

@@ -662,7 +662,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.1"
+    VERSION = "0.4.4"
 
     # Aliases for supported capabilities, to be used with the #enable command.
     ENABLE_ALIASES = {
@@ -1045,7 +1045,7 @@ module Net
     # ===== Capabilities
     #
     # The server's capabilities must include +ID+
-    # [RFC2971[https://tools.ietf.org/html/rfc2971]]
+    # [RFC2971[https://tools.ietf.org/html/rfc2971]].
     def id(client_id=nil)
       synchronize do
         send_command("ID", ClientID.new(client_id))
@@ -1058,7 +1058,7 @@ module Net
     #
     # This allows the server to send unsolicited untagged EXPUNGE #responses,
     # but does not execute any client request.  \IMAP servers are permitted to
-    # send unsolicited untagged responses at any time, except for `EXPUNGE`.
+    # send unsolicited untagged responses at any time, except for +EXPUNGE+:
     #
     # * +EXPUNGE+ can only be sent while a command is in progress.
     # * +EXPUNGE+ must _not_ be sent during #fetch, #store, or #search.
@@ -1143,10 +1143,7 @@ module Net
     end
 
     # :call-seq:
-    #   authenticate(mechanism, *,
-    #                sasl_ir: true,
-    #                registry: Net::IMAP::SASL.authenticators,
-    #                **, &) -> ok_resp
+    #   authenticate(mechanism, *, sasl_ir: true, registry: Net::IMAP::SASL.authenticators, **, &) -> ok_resp
     #
     # Sends an {AUTHENTICATE command [IMAP4rev1 §6.2.2]}[https://www.rfc-editor.org/rfc/rfc3501#section-6.2.2]
     # to authenticate the client.  If successful, the connection enters the
@@ -1330,7 +1327,7 @@ module Net
     # the server may return an untagged "NO" response with a "UIDNOTSTICKY"
     # response code indicating that the mailstore does not support persistent
     # UIDs:
-    #   @responses["NO"].last.code.name == "UIDNOTSTICKY"
+    #   imap.responses("NO", &:last)&.code&.name == "UIDNOTSTICKY"
     def select(mailbox)
       synchronize do
         @responses.clear
@@ -1420,10 +1417,10 @@ module Net
     # to the client.  +refname+ provides a context (for instance, a base
     # directory in a directory-based mailbox hierarchy).  +mailbox+ specifies a
     # mailbox or (via wildcards) mailboxes under that context.  Two wildcards
-    # may be used in +mailbox+: '*', which matches all characters *including*
-    # the hierarchy delimiter (for instance, '/' on a UNIX-hosted
-    # directory-based mailbox hierarchy); and '%', which matches all characters
-    # *except* the hierarchy delimiter.
+    # may be used in +mailbox+: <tt>"*"</tt>, which matches all characters
+    # *including* the hierarchy delimiter (for instance, "/" on a UNIX-hosted
+    # directory-based mailbox hierarchy); and <tt>"%"</tt>, which matches all
+    # characters *except* the hierarchy delimiter.
     #
     # If +refname+ is empty, +mailbox+ is used directly to determine
     # which mailboxes to match.  If +mailbox+ is empty, the root
@@ -1471,16 +1468,16 @@ module Net
     # servers, then folder creation (and listing, moving, etc) can lead to
     # errors.
     #
-    # From RFC2342:
-    #
-    #    Although typically a server will support only a single Personal
+    # From RFC2342[https://tools.ietf.org/html/rfc2342]:
+    # >>>
+    #    <em>Although typically a server will support only a single Personal
     #    Namespace, and a single Other User's Namespace, circumstances exist
     #    where there MAY be multiples of these, and a client MUST be prepared
     #    for them.  If a client is configured such that it is required to create
     #    a certain mailbox, there can be circumstances where it is unclear which
     #    Personal Namespaces it should create the mailbox in.  In these
     #    situations a client SHOULD let the user select which namespaces to
-    #    create the mailbox in.
+    #    create the mailbox in.</em>
     #
     # Related: #list, Namespaces, Namespace
     #
@@ -1668,9 +1665,9 @@ module Net
     # or more attributes whose statuses are to be requested.  Supported
     # attributes include:
     #
-    #   MESSAGES:: the number of messages in the mailbox.
-    #   RECENT:: the number of recent messages in the mailbox.
-    #   UNSEEN:: the number of unseen messages in the mailbox.
+    # MESSAGES:: the number of messages in the mailbox.
+    # RECENT:: the number of recent messages in the mailbox.
+    # UNSEEN:: the number of unseen messages in the mailbox.
     #
     # The return value is a hash of attributes. For example:
     #
@@ -1935,11 +1932,11 @@ module Net
     # to alter data associated with messages in the mailbox, in particular their
     # flags. The +set+ parameter is a number, an array of numbers, or a Range
     # object. Each number is a message sequence number.  +attr+ is the name of a
-    # data item to store: 'FLAGS' will replace the message's flag list with the
-    # provided one, '+FLAGS' will add the provided flags, and '-FLAGS' will
-    # remove them.  +flags+ is a list of flags.
+    # data item to store: <tt>"FLAGS"</tt> will replace the message's flag list
+    # with the provided one, <tt>"+FLAGS"</tt> will add the provided flags, and
+    # <tt>"-FLAGS"</tt> will remove them.  +flags+ is a list of flags.
     #
-    # The return value is an array of FetchData
+    # The return value is an array of FetchData.
     #
     # Related: #uid_store
     #
@@ -2191,7 +2188,7 @@ module Net
         .join(' ')
       synchronize do
         send_command("ENABLE #{capabilities}")
-        result = clear_responses("ENABLED").last
+        result = clear_responses("ENABLED").last || []
         @utf8_strings ||= result.include? "UTF8=ACCEPT"
         @utf8_strings ||= result.include? "IMAP4REV2"
         result
@@ -2522,7 +2519,8 @@ module Net
       when /\A(?:BAD)\z/ni
         raise BadResponseError, resp
       else
-        raise UnknownResponseError, resp
+        disconnect
+        raise InvalidResponseError, "invalid tagged resp: %p" % [resp.raw.chomp]
       end
     end
 
@@ -2644,7 +2642,7 @@ module Net
         else
           send_command(cmd, *keys)
         end
-        clear_responses("SEARCH").last
+        clear_responses("SEARCH").last || []
       end
     end
 
@@ -2693,7 +2691,7 @@ module Net
       normalize_searching_criteria(search_keys)
       synchronize do
         send_command(cmd, sort_keys, charset, *search_keys)
-        clear_responses("SORT").last
+        clear_responses("SORT").last || []
       end
     end
 
@@ -2706,7 +2704,7 @@ module Net
       normalize_searching_criteria(search_keys)
       synchronize do
         send_command(cmd, algorithm, charset, *search_keys)
-        clear_responses("THREAD").last
+        clear_responses("THREAD").last || []
       end
     end
 

data/net-imap.gemspec

@@ -2,7 +2,7 @@
 
 name = File.basename(__FILE__, ".gemspec")
 version = ["lib", Array.new(name.count("-"), "..").join("/")].find do |dir|
-  break File.foreach(File.join(__dir__, dir, "#{name.tr('-', '/')}.rb")) do |line|
+  break File.foreach(File.join(__dir__, dir, "#{name.tr('-', '/')}.rb"), :encoding=> 'utf-8') do |line|
     /^\s*VERSION\s*=\s*"(.*)"/ =~ line and break $1
   end rescue nil
 end
@@ -25,7 +25,8 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z 2>/dev/null`.split("\x0").reject { |f| f.match(%r{^(bin|test|spec|features|rfcs)/}) }
+    `git ls-files -z 2>/dev/null`.split("\x0")
+      .reject {|f| f.match(%r{^(bin|test|spec|benchmarks|features|rfcs)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/rakelib/benchmarks.rake

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+PARSER_TEST_FIXTURES = FileList.new "test/net/imap/fixtures/response_parser/*.yml"
+CLOBBER.include "benchmarks/parser.yml"
+CLEAN.include   "benchmarks/Gemfile-*"
+
+BENCHMARK_INIT = <<RUBY
+  require "yaml"
+  require "net/imap"
+
+  def load_response(file, name)
+    YAML.unsafe_load_file(file).dig(:tests, name, :response)
+      .force_encoding "ASCII-8BIT" \\
+      or abort "ERRORO: missing %p fixture data in %p" % [name, file]
+  end
+
+  parser   = Net::IMAP::ResponseParser.new
+RUBY
+
+PER_BENCHMARK_PRELUDE = <<RUBY
+  response = load_response(%p,
+                           %p)
+RUBY
+
+file "benchmarks/parser.yml" => PARSER_TEST_FIXTURES do |t|
+  require "yaml"
+  require "pathname"
+  require "net/imap"
+
+  path = Pathname.new(__dir__) / "../test/net/imap/fixtures/response_parser"
+  files = path.glob("*.yml")
+  tests = files.flat_map {|file|
+    file.read
+      .gsub(%r{([-:]) !ruby/struct:\S+}) { $1 }
+      .then {
+        YAML.safe_load(_1, filename: file,
+                       permitted_classes: [Symbol, Regexp], aliases: true)
+      }
+      .fetch(:tests)
+      .select {|test_name, test|
+        :parser_assert_equal == test.fetch(:test_type) {
+          test.key?(:expected) ? :parser_assert_equal : :parser_pending
+        }
+      }
+      .map {|test_name, _|
+        [file.relative_path_from(__dir__).to_s, test_name.to_s]
+      }
+  }
+
+  benchmarks = tests.map {|file, fixture_name|
+    {"name"    => fixture_name.delete_prefix("test_"),
+     "prelude" => PER_BENCHMARK_PRELUDE % [file, fixture_name],
+     "script"  => "parser.parse(response)"}
+  }
+    .sort_by { _1["name"] }
+
+  YAML.dump({"prelude" => BENCHMARK_INIT, "benchmark" => benchmarks})
+    .then { File.write t.name, _1 }
+end
+
+namespace :benchmarks do
+  desc "Generate benchmarks from fixture data"
+  task :generate => "benchmarks/parser.yml"
+
+  desc "run the parser benchmarks comparing multiple gem versions"
+  task :compare => :generate do |task, args|
+    cd Pathname.new(__dir__) + ".."
+    current = `git describe --tags --dirty`.chomp
+    current = "dev" if current.empty?
+    versions = args.to_a
+    if versions.empty?
+      latest = %x{git describe --tags --abbrev=0 --match 'v*.*.*'}.chomp
+      versions = latest.empty? ? [] : [latest.delete_prefix("v")]
+    end
+    versions = versions.to_h { [_1, "Gemfile-v#{_1}"] }
+    cd "benchmarks" do
+      versions.each do |version, gemfile|
+        File.write gemfile, <<~RUBY
+          # frozen_string_literal: true
+          source "https://rubygems.org"
+          gem "net-imap", #{version.dump}
+        RUBY
+      end
+      versions = {current => "../Gemfile" , **versions}.map {
+        "%s::/usr/bin/env BUNDLE_GEMFILE=%s ruby" % _1
+      }.join(";")
+
+      extra = ENV.fetch("BENCHMARK_ARGS", "").shellsplit
+
+      sh("benchmark-driver",
+         "--bundler",
+         "-e", versions,
+         "parser.yml",
+         *extra)
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-imap
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.4
 platform: ruby
 authors:
 - Shugo Maeda
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-09 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-protocol
@@ -83,10 +83,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- benchmarks/generate_parser_benchmarks
-- benchmarks/parser.yml
-- benchmarks/stringprep.yml
-- benchmarks/table-regexps.yml
 - docs/styles.css
 - lib/net/imap.rb
 - lib/net/imap/authenticators.rb
@@ -123,6 +119,7 @@ files:
 - lib/net/imap/stringprep/tables.rb
 - lib/net/imap/stringprep/trace.rb
 - net-imap.gemspec
+- rakelib/benchmarks.rake
 - rakelib/rdoc.rake
 - rakelib/rfcs.rake
 - rakelib/saslprep.rake

data/benchmarks/generate_parser_benchmarks

@@ -1,52 +0,0 @@
-#!/usr/bin/env ruby
-
-require "yaml"
-require "pathname"
-require "net/imap"
-
-path = Pathname.new(__dir__) / "../test/net/imap/fixtures/response_parser"
-files = path.glob("*.yml")
-tests = files.flat_map {|file|
-  file.to_s
-    .then { YAML.unsafe_load_file _1 }
-    .fetch(:tests)
-    .select {|test_name, test|
-      :parser_assert_equal == test.fetch(:test_type) {
-        test.key?(:expected) ? :parser_assert_equal : :parser_pending
-      }
-    }
-    .map {|test_name, _|
-      [
-        file.relative_path_from(__dir__).to_s,
-        test_name.to_s,
-      ]
-    }
-}
-
-init = <<RUBY
-  require "yaml"
-  require "net/imap"
-
-  def load_response(file, name)
-    YAML.unsafe_load_file(file).dig(:tests, name, :response)
-      .force_encoding "ASCII-8BIT" \\
-      or abort "ERRORO: missing %p fixture data in %p" % [name, file]
-  end
-
-  parser   = Net::IMAP::ResponseParser.new
-RUBY
-
-prelude = <<RUBY
-  response = load_response(%p,
-                           %p)
-RUBY
-script = "parser.parse(response)"
-
-benchmarks = tests.map {|file, fixture_name|
-  name = fixture_name.delete_prefix("test_")
-  {name:, prelude: prelude % [file, fixture_name], script:}
-    .transform_keys(&:to_s)
-}
-  .sort_by { _1["name"] }
-
-puts YAML.dump({"prelude" => init, "benchmark" => benchmarks})