net-imap 0.3.7 → 0.5.6

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
@@ -11,21 +11,23 @@ Gem::Specification.new do |spec|
   spec.name          = name
   spec.version       = version
   spec.authors       = ["Shugo Maeda", "nicholas a. evans"]
-  spec.email         = ["shugo@ruby-lang.org", "nick@ekenosen.net"]
+  spec.email         = ["shugo@ruby-lang.org", "nick@rubinick.dev"]
 
   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(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
   spec.licenses       = ["Ruby", "BSD-2-Clause"]
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage + "/releases"
 
   # 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)/}) }
+  spec.files         = Dir.chdir(__dir__) do
+    `git ls-files -z 2>/dev/null`.split("\x0")
+      .grep_v(%r{^(\.git(ignore)?|\.mailmap|(\.github|bin|test|spec|benchmarks|features|rfcs)/)})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -33,7 +35,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "net-protocol"
   spec.add_dependency "date"
-
-  spec.add_development_dependency "digest"
-  spec.add_development_dependency "strscan"
 end

data/rakelib/benchmarks.rake

@@ -0,0 +1,91 @@
+# 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
+
+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/(object|struct|array):\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, test| [test_name.to_s, test.fetch(:response)] }
+  }
+
+  benchmarks = tests.map {|fixture_name, response|
+    {"name"    => fixture_name.delete_prefix("test_"),
+     "prelude" => "response = -%s.b" % [response.dump],
+     "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

data/rakelib/rfcs.rake

@@ -145,6 +145,8 @@ RFCS = {
   8514 => "IMAP SAVEDATE",
   8970 => "IMAP PREVIEW",
   9208 => "IMAP QUOTA, QUOTA=, QUOTASET",
+  9394 => "IMAP PARTIAL",
+  9586 => "IMAP UIDONLY",
 
   # etc...
   3629 => "UTF8",

data/rakelib/saslprep.rake

@@ -10,17 +10,17 @@ end
 
 directory "lib/net/imap/sasl"
 
-file "lib/net/imap/sasl/stringprep_tables.rb" => generator.rb_deps do |t|
+file "lib/net/imap/stringprep/tables.rb" => generator.rb_deps do |t|
   File.write t.name, generator.stringprep_rb
 end
 
-file "lib/net/imap/sasl/saslprep_tables.rb" => generator.rb_deps do |t|
+file "lib/net/imap/stringprep/saslprep_tables.rb" => generator.rb_deps do |t|
   File.write t.name, generator.saslprep_rb
 end
 
 GENERATED_RUBY = FileList.new(
-  "lib/net/imap/sasl/stringprep_tables.rb",
-  "lib/net/imap/sasl/saslprep_tables.rb",
+  "lib/net/imap/stringprep/tables.rb",
+  "lib/net/imap/stringprep/saslprep_tables.rb",
 )
 
 CLEAN.include   generator.clean_deps

data/rakelib/string_prep_tables_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "set" unless defined?(::Set)
+
 # Generator for stringprep regexps.
 #
 # Combines Unicode character classes with generated tables.  Generated regexps
@@ -62,9 +64,9 @@ class StringPrepTablesGenerator
       # This file is generated from RFC3454, by rake.  Don't edit directly.
       #++
 
-      module Net::IMAP::SASL
+      module Net::IMAP::StringPrep
 
-        module StringPrep
+        module Tables
 
           #{asgn_table "A.1"}
 
@@ -74,6 +76,12 @@ class StringPrepTablesGenerator
 
           #{asgn_table "B.3"}
 
+          #{asgn_mapping "B.1", ""}
+
+          #{asgn_mapping "B.2"}
+
+          #{asgn_mapping "B.3"}
+
           #{asgn_table "C.1.1"}
 
           #{asgn_table "C.1.2"}
@@ -105,14 +113,16 @@ class StringPrepTablesGenerator
 
           BIDI_DESC_REQ2 = "A string with RandALCat characters must not contain LCat characters."
 
-          # Bidirectional Characters [StringPrep, §6], Requirement 2::
+          # Bidirectional Characters [StringPrep, §6], Requirement 2
+          # >>>
           #   If a string contains any RandALCat character, the string MUST NOT
           #   contain any LCat character.
           BIDI_FAILS_REQ2 = #{bidi_fails_req2.inspect}.freeze
 
           BIDI_DESC_REQ3 = "A string with RandALCat characters must start and end with RandALCat characters."
 
-          # Bidirectional Characters [StringPrep, §6], Requirement 3::
+          # Bidirectional Characters [StringPrep, §6], Requirement 3
+          # >>>
           #   If a string contains any RandALCat character, a RandALCat
           #   character MUST be the first character of the string, and a
           #   RandALCat character MUST be the last character of the string.
@@ -122,15 +132,21 @@ class StringPrepTablesGenerator
           BIDI_FAILURE = #{bidi_failure_regexp.inspect}.freeze
 
           # Names of each codepoint table in the RFC-3454 appendices
-          TABLE_TITLES = {
+          TITLES = {
             #{table_titles_rb}
           }.freeze
 
           # Regexps matching each codepoint table in the RFC-3454 appendices
-          TABLE_REGEXPS = {
+          REGEXPS = {
             #{table_regexps_rb}
           }.freeze
 
+          MAPPINGS = {
+            "B.1" => [IN_B_1, MAP_B_1].freeze,
+            "B.2" => [IN_B_2, MAP_B_2].freeze,
+            "B.3" => [IN_B_3, MAP_B_3].freeze,
+          }.freeze
+
         end
       end
     RUBY
@@ -157,27 +173,30 @@ class StringPrepTablesGenerator
       # This file is generated from RFC3454, by rake.  Don't edit directly.
       #++
 
-      module Net::IMAP::SASL
+      module Net::IMAP::StringPrep
 
         module SASLprep
 
           # RFC4013 §2.1 Mapping - mapped to space
-          # * non-ASCII space characters (\\StringPrep\\[\\"C.1.2\\"]) that can be
-          #   mapped to SPACE (U+0020), and
+          # >>>
+          #   non-ASCII space characters (\\StringPrep\\[\\"C.1.2\\"]) that can
+          #   be mapped to SPACE (U+0020)
           #
           # Equal to \\StringPrep\\[\\"C.1.2\\"].
-          # Redefined here to avoid loading the StringPrep module.
+          # Redefined here to avoid loading StringPrep::Tables unless necessary.
           MAP_TO_SPACE = #{regex_str "C.1.2"}
 
           # RFC4013 §2.1 Mapping - mapped to nothing
-          #   the "commonly mapped to nothing" characters (\\StringPrep\\[\\"B.1\\"])
-          #   that can be mapped to nothing.
+          # >>>
+          #   the "commonly mapped to nothing" characters
+          #   (\\StringPrep\\[\\"B.1\\"]) that can be mapped to nothing.
           #
           # Equal to \\StringPrep\\[\\"B.1\\"].
-          # Redefined here to avoid loading the StringPrep module.
+          # Redefined here to avoid loading StringPrep::Tables unless necessary.
           MAP_TO_NOTHING = #{regex_str "B.1"}
 
-          # RFC4013 §2.3 Prohibited Output::
+          # RFC4013 §2.3 Prohibited Output
+          # >>>
           # * Non-ASCII space characters — \\StringPrep\\[\\"C.1.2\\"]
           # * ASCII control characters — \\StringPrep\\[\\"C.2.1\\"]
           # * Non-ASCII control characters — \\StringPrep\\[\\"C.2.2\\"]
@@ -192,45 +211,52 @@ class StringPrepTablesGenerator
 
           # Adds unassigned (by Unicode 3.2) codepoints to TABLES_PROHIBITED.
           #
-          # RFC4013 §2.5 Unassigned Code Points::
-          #   This profile specifies the \\StringPrep\\[\\"A.1\\"] table as its list of
-          #   unassigned code points.
+          # RFC4013 §2.5 Unassigned Code Points
+          # >>>
+          #   This profile specifies the \\StringPrep\\[\\"A.1\\"] table as its
+          #   list of unassigned code points.
           TABLES_PROHIBITED_STORED = ["A.1", *TABLES_PROHIBITED].freeze
 
-          # Matches codepoints prohibited by RFC4013 §2.3.
+          # A Regexp matching codepoints prohibited by RFC4013 §2.3.
           #
-          # See TABLES_PROHIBITED.
-          #
-          # Equal to +Regexp.union+ of the TABLES_PROHIBITED tables.  Redefined
-          # here to avoid loading the StringPrep module unless necessary.
+          # This combines all of the TABLES_PROHIBITED tables.
           PROHIBITED_OUTPUT = #{regex_str(*SASL_TABLES_PROHIBITED)}
 
-          # RFC4013 §2.5 Unassigned Code Points::
-          #   This profile specifies the \\StringPrep\\[\\"A.1\\"] table as its list of
-          #   unassigned code points.
+          # RFC4013 §2.5 Unassigned Code Points
+          # >>>
+          #   This profile specifies the \\StringPrep\\[\\"A.1\\"] table as its
+          #   list of unassigned code points.
+          #
+          # Equal to \\StringPrep\\[\\"A.1\\"].
+          # Redefined here to avoid loading StringPrep::Tables unless necessary.
           UNASSIGNED = #{regex_str "A.1"}
 
-          # Matches codepoints prohibited by RFC4013 §2.3 and §2.5.
+          # A Regexp matching codepoints prohibited by RFC4013 §2.3 and §2.5.
           #
-          # See TABLES_PROHIBITED_STORED.
+          # This combines PROHIBITED_OUTPUT and UNASSIGNED.
           PROHIBITED_OUTPUT_STORED = Regexp.union(
             UNASSIGNED, PROHIBITED_OUTPUT
           ).freeze
 
           # Bidirectional Characters [StringPrep, §6]
+          #
+          # A Regexp for strings that don't satisfy StringPrep's Bidirectional
+          # Characters rules.
+          #
+          # Equal to StringPrep::Tables::BIDI_FAILURE.
+          # Redefined here to avoid loading StringPrep::Tables unless necessary.
           BIDI_FAILURE = #{bidi_failure_regexp.inspect}.freeze
 
-          # Matches strings prohibited by RFC4013 §2.3 and §2.4.
+          # A Regexp matching strings prohibited by RFC4013 §2.3 and §2.4.
           #
-          # This checks prohibited output and bidirectional characters.
+          # This combines PROHIBITED_OUTPUT and BIDI_FAILURE.
           PROHIBITED = Regexp.union(
             PROHIBITED_OUTPUT, BIDI_FAILURE,
           )
 
-          # Matches strings prohibited by RFC4013 §2.3, §2.4, and §2.5.
+          # A Regexp matching strings prohibited by RFC4013 §2.3, §2.4, and §2.5.
           #
-          # This checks prohibited output, bidirectional characters, and
-          # unassigned codepoints.
+          # This combines PROHIBITED_OUTPUT_STORED and BIDI_FAILURE.
           PROHIBITED_STORED = Regexp.union(
             PROHIBITED_OUTPUT_STORED, BIDI_FAILURE,
           )
@@ -284,6 +310,15 @@ class StringPrepTablesGenerator
       .map{|s,e| s..(e || s)}
   end
 
+  # TODO: DRY with unicode_normalize
+  def to_map(table)
+    table = table.to_hash
+      .transform_keys { Integer _1, 16 }
+      .transform_keys { [_1].pack("U*") }
+      .transform_values {|cps| cps.map { Integer _1, 16 } }
+      .transform_values { _1.pack("U*") }
+  end
+
   # Starting from a codepoints array (rather than ranges) to deduplicate merged
   # tables.
   def to_regexp(codepoints, negate: false)
@@ -352,6 +387,13 @@ class StringPrepTablesGenerator
     asgn_regex(name, regexp_for(name, negate: negate), negate: negate)
   end
 
+  def asgn_mapping(name, replacement = to_map(tables[name]))
+    cname = name.tr(?., ?_).upcase
+    "# Replacements for %s\n%s%s = %p.freeze" % [
+      "IN_#{name}", "  " * 2, "MAP_#{cname}", replacement,
+    ]
+  end
+
   def regexp_const_desc(name, negate: false)
     if negate then "Matches the negation of the %s table" % [name]
     else %q{%s \\StringPrep\\[\\"%s\\"]} % [titles.fetch(name), name]
@@ -376,40 +418,22 @@ class StringPrepTablesGenerator
   def bidi_L        ; regexp_for "D.2" end
 
   def bidi_fails_req2
-    / # RandALCat followed by LCat
-      (?<r_and_al_cat>#{bidi_R_AL.source})
-        .*?
-        (?<l_cat>#{bidi_L.source})
-      | # RandALCat preceded by LCat
-        \g<l_cat> .*? \g<r_and_al_cat>
-    /mux
+    Regexp.union(
+      /#{bidi_R_AL}.*?#{bidi_L}/mu, # RandALCat followed by LCat
+      /#{bidi_L}.*?#{bidi_R_AL}/mu, # RandALCat preceded by LCat
+    )
   end
 
   def bidi_fails_req3
-    / # contains RandALCat but doesn't start with RandALCat
-      \A(?<not_r_nor_al>#{bidi_not_R_AL})
-        .*?
-        (?<r_and_al_cat>#{bidi_R_AL})
-      | # contains RandALCat but doesn't end with RandALCat
-        \g<r_and_al_cat> .*? \g<not_r_nor_al>\z
-    /mux
+    # contains RandALCat:
+    Regexp.union(
+      /\A#{bidi_not_R_AL}.*?#{bidi_R_AL}/mu, # but doesn't start with RandALCat
+      /#{bidi_R_AL}.*?#{bidi_not_R_AL}\z/mu, # but doesn't end   with RandALCat
+    )
   end
 
-  # shares the bidi_R_AL definition between both req2 and req3
   def bidi_failure_regexp
-    req3_with_backref = bidi_fails_req3.source
-      .gsub(%r{\(\?\<r_and_al_cat\>\(.*?\)\)}, "\g<r_and_al_cat>")
-      .then{|re|"(?mx-i:#{re})"}
-    /#{bidi_fails_req2} | #{req3_with_backref}/mux
-  end
-
-  def bidi_consts
-    <<~RUBY
-      #############
-          # Bidirectional checks.
-          #
-
-    RUBY
+    Regexp.union(bidi_fails_req2, bidi_fails_req3)
   end
 
   SASL_TABLES_PROHIBITED = %w[

data/sample/net-imap.rb

@@ -0,0 +1,167 @@
+require 'net/imap'
+require "getoptlong"
+
+$stdout.sync = true
+$port = nil
+$user = ENV["USER"] || ENV["LOGNAME"]
+$auth = "login"
+$ssl = false
+$starttls = false
+
+def usage
+  <<EOF
+usage: #{$0} [options] <host>
+
+  --help                        print this message
+  --port=PORT                   specifies port
+  --user=USER                   specifies user
+  --auth=AUTH                   specifies auth type
+  --starttls                    use starttls
+  --ssl                         use ssl
+EOF
+end
+
+begin
+  require 'io/console'
+rescue LoadError
+  def _noecho(&block)
+    system("stty", "-echo")
+    begin
+      yield STDIN
+    ensure
+      system("stty", "echo")
+    end
+  end
+else
+  def _noecho(&block)
+    STDIN.noecho(&block)
+  end
+end
+
+def get_password
+  print "password: "
+  begin
+    return _noecho(&:gets).chomp
+  ensure
+    puts
+  end
+end
+
+def get_command
+  printf("%s@%s> ", $user, $host)
+  if line = gets
+    return line.strip.split(/\s+/)
+  else
+    return nil
+  end
+end
+
+parser = GetoptLong.new
+parser.set_options(['--debug', GetoptLong::NO_ARGUMENT],
+  ['--help', GetoptLong::NO_ARGUMENT],
+  ['--port', GetoptLong::REQUIRED_ARGUMENT],
+  ['--user', GetoptLong::REQUIRED_ARGUMENT],
+  ['--auth', GetoptLong::REQUIRED_ARGUMENT],
+  ['--starttls', GetoptLong::NO_ARGUMENT],
+  ['--ssl', GetoptLong::NO_ARGUMENT])
+begin
+  parser.each_option do |name, arg|
+    case name
+    when "--port"
+      $port = arg
+    when "--user"
+      $user = arg
+    when "--auth"
+      $auth = arg
+    when "--ssl"
+      $ssl = true
+    when "--starttls"
+      $starttls = true
+    when "--debug"
+      Net::IMAP.debug = true
+    when "--help"
+      usage
+      exit
+    end
+  end
+rescue
+  abort usage
+end
+
+$host = ARGV.shift
+unless $host
+  abort usage
+end
+
+imap = Net::IMAP.new($host, :port => $port, :ssl => $ssl)
+begin
+  imap.starttls if $starttls
+  class << password = method(:get_password)
+    alias to_str call
+  end
+  imap.authenticate($auth, $user, password)
+  while true
+    cmd, *args = get_command
+    break unless cmd
+    begin
+      case cmd
+      when "list"
+        for mbox in imap.list("", args[0] || "*")
+          if mbox.attr.include?(Net::IMAP::NOSELECT)
+            prefix = "!"
+          elsif mbox.attr.include?(Net::IMAP::MARKED)
+            prefix = "*"
+          else
+            prefix = " "
+          end
+          print prefix, mbox.name, "\n"
+        end
+      when "select"
+        imap.select(args[0] || "inbox")
+        print "ok\n"
+      when "close"
+        imap.close
+        print "ok\n"
+      when "summary"
+        unless messages = imap.responses["EXISTS"][-1]
+          puts "not selected"
+          next
+        end
+        if messages > 0
+          for data in imap.fetch(1..-1, ["ENVELOPE"])
+            print data.seqno, ": ", data.attr["ENVELOPE"].subject, "\n"
+          end
+        else
+          puts "no message"
+        end
+      when "fetch"
+        if args[0]
+          data = imap.fetch(args[0].to_i, ["RFC822.HEADER", "RFC822.TEXT"])[0]
+          puts data.attr["RFC822.HEADER"]
+          puts data.attr["RFC822.TEXT"]
+        else
+          puts "missing argument"
+        end
+      when "logout", "exit", "quit"
+        break
+      when "help", "?"
+        print <<EOF
+list [pattern]                  list mailboxes
+select [mailbox]                select mailbox
+close                           close mailbox
+summary                         display summary
+fetch [msgno]                   display message
+logout                          logout
+help, ?                         display help message
+EOF
+      else
+        print "unknown command: ", cmd, "\n"
+      end
+    rescue Net::IMAP::Error
+      puts $!
+    end
+  end
+ensure
+  imap.logout
+  imap.disconnect
+end