sisimai 4.25.4 → 4.25.5

data/lib/sisimai/mail.rb

@@ -3,15 +3,11 @@ module Sisimai
   # wrapper class of Sisimai::Mail::Mbox and Sisimai::Mail::Maildir classes.
   class Mail
     # Imported from p5-Sisimail/lib/Sisimai/Mail.pm
-    @@roaccessors = [
-      :path,  # [String] path to mbox or Maildir/
-      :type,  # [String] Data type: mailbox, maildir, or stdin
-    ]
-    @@rwaccessors = [
-      :mail,  # [Sisimai::Mail::[Mbox,Maildir,Memory,STDIN]] Object
-    ]
-    @@roaccessors.each { |e| attr_reader   e }
-    @@rwaccessors.each { |e| attr_accessor e }
+    # :path [String] path to mbox or Maildir/
+    # :type [String] Data type: mailbox, maildir, or stdin
+    # :mail [Sisimai::Mail::[Mbox,Maildir,Memory,STDIN]] Object
+    attr_reader   :path, :type
+    attr_accessor :mail
 
     # Constructor of Sisimai::Mail
     # @param    [String] argv1        Path to mbox or Maildir/

data/lib/sisimai/mail/maildir.rb

@@ -4,19 +4,15 @@ module Sisimai
     # Maildir/ directory.
     class Maildir
       # Imported from p5-Sisimail/lib/Sisimai/Mail/Maildir.pm
-      @@roaccessors = [
-        :dir,     # [String] Path to Maildir/
-        :size,    # [Integer] The number of entires in the directory
-      ]
-      @@rwaccessors = [
-        :path,    # [String] Path to each file
-        :file,    # [String] Each file name of a mail in the Maildir/
-        :inodes,  # [Array]  i-node List of files in the Maildir/
-        :count,   # [Integer] The number of file has read
-        :handle,  # [IO::Dir] Directory handle
-      ]
-      @@roaccessors.each { |e| attr_reader   e }
-      @@rwaccessors.each { |e| attr_accessor e }
+      # :dir    [String] Path to Maildir/
+      # :size   [Integer] The number of entires in the directory
+      # :path   [String] Path to each file
+      # :file,  [String] Each file name of a mail in the Maildir/
+      # :inodes [Array]  i-node List of files in the Maildir/
+      # :count  [Integer] The number of file has read
+      # :handle [IO::Dir] Directory handle
+      attr_reader :dir, :size
+      attr_accessor :path, :file, :inodes, :count, :handle
 
       # Constructor of Sisimai::Mail::Maildir
       # @param    [String] argvs                Path to Maildir/
@@ -54,7 +50,7 @@ module Sisimai
             next unless File.readable?(emailindir)
 
             emailinode = File.stat(emailindir).ino
-            next if self.inodes.key?(emailinode)
+            next if self.inodes[emailinode]
 
             File.open(emailindir, 'r:UTF-8') do |f|
               readbuffer = f.read

data/lib/sisimai/mail/mbox.rb

@@ -3,18 +3,14 @@ module Sisimai
     # Sisimai::Mail::Mbox is a mailbox file (UNIX mbox) reader.
     class Mbox
       # Imported from p5-Sisimail/lib/Sisimai/Mail/Mbox.pm
-      @@roaccessors = [
-        :dir,     # [String]  Directory name of the mbox
-        :file,    # [String]  File name of the mbox
-        :path,    # [String]  Path to mbox
-        :size,    # [Integer] File size of the mbox
-      ]
-      @@rwaccessors = [
-        :offset,  # [Integer]  Offset position for seeking
-        :handle,  # [IO::File] File handle
-      ]
-      @@roaccessors.each { |e| attr_reader   e }
-      @@rwaccessors.each { |e| attr_accessor e }
+      # :dir    [String]  Directory name of the mbox
+      # :file   [String]  File name of the mbox
+      # :path   [String]  Path to mbox
+      # :size   [Integer] File size of the mbox
+      # :offset [Integer]  Offset position for seeking
+      # :handle [IO::File] File handle
+      attr_reader :dir, :file, :path, :size
+      attr_accessor :offset, :handle
 
       # Constructor of Sisimai::Mail::Mbox
       # @param    [String] argv1            Path to mbox

data/lib/sisimai/mail/memory.rb

@@ -3,15 +3,11 @@ module Sisimai
     # Sisimai::Mail::Memory is a class for reading an email string
     class Memory
       # Imported from p5-Sisimail/lib/Sisimai/Mail/Memory.pm
-      @@roaccessors = [
-        :size,    # [Integer] data size of the email text
-      ]
-      @@rwaccessors = [
-        :data,    # [Array]   Entire bounce mail message
-        :offset,  # [Integer] Index of ":data"
-      ]
-      @@roaccessors.each { |e| attr_reader   e }
-      @@rwaccessors.each { |e| attr_accessor e }
+      # :size   [Integer] data size of the email text
+      # :data   [Array]   Entire bounce mail message
+      # :offset [Integer] Index of ":data"
+      attr_reader :size
+      attr_accessor :data, :offset
 
       # Constructor of Sisimai::Mail::Memory
       # @param    [String] argv1              Entire email string

data/lib/sisimai/mail/stdin.rb

@@ -4,17 +4,13 @@ module Sisimai
     # STDIN
     class STDIN
       # Imported from p5-Sisimail/lib/Sisimai/Mail/STDIN.pm
-      @@roaccessors = [
-        :path,    # [String]  Path to mbox
-        :name,    # [String]  File name of the mbox
-        :size,    # [Integer] File size of the mbox
-      ]
-      @@rwaccessors = [
-        :offset,  # [Integer]  Offset position for seeking
-        :handle,  # [IO::File] File handle
-      ]
-      @@roaccessors.each { |e| attr_reader   e }
-      @@rwaccessors.each { |e| attr_accessor e }
+      # :path   [String]  Path to mbox
+      # :name   [String]  File name of the mbox
+      # :size   [Integer] File size of the mbox
+      # :offset [Integer]  Offset position for seeking
+      # :handle [IO::File] File handle
+      attr_reader :path, :name, :size
+      attr_accessor :offset, :handle
 
       # Constructor of Sisimai::Mail::STDIN
       # @param    [IO::STDIN] stdin      Standard-In

data/lib/sisimai/mda.rb

@@ -91,10 +91,10 @@ module Sisimai
         agentname0 = ''   # [String] MDA name
         reasonname = ''   # [String] Error reason
         bouncemesg = ''   # [String] Error message
-        hasdivided = mbody.split("\n")
+        bodyslices = mbody.split("\n")
         linebuffer = []
 
-        while e = hasdivided.shift do
+        while e = bodyslices.shift do
           # Check each line with each MDA's symbol regular expression.
           if agentname0 == ''
             # Try to match with each regular expression

data/lib/sisimai/message.rb

@@ -5,6 +5,13 @@ module Sisimai
   # method is not a bounce email, the method returns nil.
   class Message
     # Imported from p5-Sisimail/lib/Sisimai/Message.pm
+    # :from   [String] UNIX From line
+    # :header [Hash]   Header part of an email
+    # :ds     [Array]  Parsed data by Sisimai::Lhost::* module
+    # :rfc822 [Hash]   Header part of the original message
+    # :catch  [Any]    The results returned by hook method
+    attr_accessor :from, :header, :ds, :rfc822, :catch
+
     require 'sisimai/arf'
     require 'sisimai/mime'
     require 'sisimai/order'
@@ -14,15 +21,6 @@ module Sisimai
     require 'sisimai/rfc3834'
     require 'sisimai/smtp/error'
 
-    @@rwaccessors = [
-      :from,    # [String] UNIX From line
-      :header,  # [Hash]   Header part of an email
-      :ds,      # [Array]  Parsed data by Sisimai::Lhost::* module
-      :rfc822,  # [Hash]   Header part of the original message
-      :catch,   # [Any]      The results returned by hook method
-    ]
-    @@rwaccessors.each { |e| attr_accessor e }
-
     DefaultSet = Sisimai::Order.another
     ExtHeaders = Sisimai::Order.headers
     SubjectTab = Sisimai::Order.by('subject')
@@ -47,31 +45,19 @@ module Sisimai
     def initialize(data: '', **argvs)
       return nil if data.empty?
 
-      email = data
-      input = email.is_a?(Hash) ? 'json' : 'email'
+      email = data.scrub('?').gsub("\r\n", "\n")
       field = argvs[:field] || []
 
-      if input == 'email'
-        # Email message
-        return nil if email.empty?
-        email = email.scrub('?').gsub("\r\n", "\n")
-      end
-
       unless field.is_a? Array
         # Unsupported value in "field"
         warn ' ***warning: "field" accepts an array reference only'
         return nil
       end
 
-      methodargv = {
-        'data'  => email,
-        'hook'  => argvs[:hook] || nil,
-        'field' => field,
-        'input' => input,
-      }
+      methodargv = { 'data' => email, 'hook' => argvs[:hook] || nil, 'field' => field }
       [:load, :order].each do |e|
         # Order of MTA modules
-        next unless argvs.key?(e)
+        next unless argvs[e]
         next unless argvs[e].is_a? Array
         next if argvs[e].empty?
         methodargv[e.to_s] = argvs[e]
@@ -79,7 +65,7 @@ module Sisimai
 
       datasource = Sisimai::Message.make(methodargv)
       return nil unless datasource
-      return nil unless datasource.key?('ds')
+      return nil unless datasource['ds']
 
       @from   = datasource['from']
       @header = datasource['header']
@@ -120,52 +106,39 @@ module Sisimai
       }
       tobeloaded = Sisimai::Message.load(methodargv)
 
-      if argvs['input'] == 'email'
-        # Email message
-        # 1. Split email data to headers and a body part.
-        return nil unless aftersplit = Sisimai::Message.divideup(email)
-
-        # 2. Convert email headers from text to hash reference
-        headerargv = {
-          'extheaders' => ExtHeaders,
-          'tryonfirst' => [],
-          'extrafield' => argvs['field'] || [],
-        }
-        processing['from']   = aftersplit['from']
-        processing['header'] = Sisimai::Message.headers(aftersplit['header'], headerargv)
-
-        # 3. Check headers for detecting MTA modules
-        if headerargv['tryonfirst'].empty?
-          headerargv['tryonfirst'] += Sisimai::Message.makeorder(processing['header'])
-        end
+      # 1. Split email data to headers and a body part.
+      return nil unless aftersplit = Sisimai::Message.divideup(email)
 
-        # 4. Rewrite message body for detecting the bounce reason
-        methodargv = {
-          'hook' => hookmethod,
-          'mail' => processing,
-          'body' => aftersplit['body'],
-          'tryonfirst' => headerargv['tryonfirst'],
-          'tobeloaded' => tobeloaded,
-        }
-        return nil unless bouncedata = Sisimai::Message.parse(methodargv)
-      else
-        # JSON object
-        methodargv = {
-          'hook' => hookmethod,
-          'json' => argvs['data'],
-          'tobeloaded' => tobeloaded.concat(Sisimai::Order.forjson),
-        }
-        return nil unless bouncedata = Sisimai::Message.adapt(methodargv)
+      # 2. Convert email headers from text to hash reference
+      headerargv = {
+        'extheaders' => ExtHeaders,
+        'tryonfirst' => [],
+        'extrafield' => argvs['field'] || [],
+      }
+      processing['from']   = aftersplit['from']
+      processing['header'] = Sisimai::Message.headers(aftersplit['header'], headerargv)
+
+      # 3. Check headers for detecting MTA modules
+      if headerargv['tryonfirst'].empty?
+        headerargv['tryonfirst'] += Sisimai::Message.makeorder(processing['header'])
       end
-      return nil if bouncedata.empty?
 
+      # 4. Rewrite message body for detecting the bounce reason
+      methodargv = {
+        'hook' => hookmethod,
+        'mail' => processing,
+        'body' => aftersplit['body'],
+        'tryonfirst' => headerargv['tryonfirst'],
+        'tobeloaded' => tobeloaded,
+      }
+      return nil unless bouncedata = Sisimai::Message.parse(methodargv)
+      return nil if bouncedata.empty?
       %w|ds catch rfc822|.each { |e| processing[e] = bouncedata[e] }
-      if argvs['input'] == 'email'
-        # 5. Rewrite headers of the original message in the body part
-        p = bouncedata['rfc822']
-        p = aftersplit['body'] if p.empty?
-        processing['rfc822'] = p.is_a?(::String) ? Sisimai::Message.takeapart(p) : p
-      end
+
+      # 5. Rewrite headers of the original message in the body part
+      p = bouncedata['rfc822']
+      p = aftersplit['body'] if p.empty?
+      processing['rfc822'] = p.is_a?(::String) ? Sisimai::Message.takeapart(p) : p
 
       return processing
     end
@@ -182,7 +155,7 @@ module Sisimai
 
       %w[load order].each do |e|
         # The order of MTA modules specified by user
-        next unless argvs.key?(e)
+        next unless argvs[e]
         next unless argvs[e].is_a? Array
         next if argvs[e].empty?
 
@@ -198,7 +171,6 @@ module Sisimai
             warn ' ***warning: Failed to load ' << v
             next
           end
-          next unless argvs.input == 'email'
 
           Module.const_get(v).headerlist.each do |w|
             # Get header name which required user defined MTA module
@@ -252,7 +224,7 @@ module Sisimai
       structured = {}
       extheaders = argvs['extheaders'] || []
       extrafield = argvs['extrafield'] || []
-      hasdivided = heads.split("\n")
+      headslices = heads.split("\n")
 
       HeaderList.each { |e| structured[e] = nil  }
       HeaderList.each { |e| allheaders[e] = true }
@@ -263,11 +235,11 @@ module Sisimai
         extrafield.each { |e| allheaders[e] = true }
       end
 
-      while e = hasdivided.shift do
+      while e = headslices.shift do
         # Convert email headers to hash
         if cv = e.match(/\A[ \t]+(.+)\z/)
           # Continued (foled) header value from the previous line
-          next unless allheaders.key?(currheader)
+          next unless allheaders[currheader]
 
           # Header line continued from the previous line
           if structured[currheader].is_a? Array
@@ -281,12 +253,11 @@ module Sisimai
           # split the line into a header name and a header content
           (lhs, rhs) = e.split(/:[ ]*/, 2)
           currheader = lhs ? lhs.downcase : ''
-          next unless allheaders.key?(currheader)
+          next unless allheaders[currheader]
 
-          if IsMultiple.key?(currheader)
+          if IsMultiple[currheader]
             # Such as 'Received' header, there are multiple headers in a single
             # email message.
-            #rhs = rhs.tr("\t", ' ').squeeze(' ')
             rhs = rhs.tr("\t", ' ')
             structured[currheader] << rhs
           else
@@ -320,7 +291,7 @@ module Sisimai
       return nil unless block['header']
       return nil unless block['body']
 
-      if block['header'][0, 5] == 'From '
+      if block['header'].start_with?('From ')
         # From MAILER-DAEMON Tue Feb 11 00:00:00 2014
         block['from'] = block['header'].split(/\n/, 2)[0].delete("\r")
       else
@@ -345,9 +316,9 @@ module Sisimai
       previousfn = '' # Previous field name
       asciiarmor = {} # Header names which has MIME encoded value
       headerpart = {} # Required headers in the original message part
-      hasdivided = heads.split("\n")
+      headslices = heads.split("\n")
 
-      while e = hasdivided.shift do
+      while e = headslices.shift do
         # Header name as a key, The value of header as a value
         if e.start_with?(' ', "\t")
           # Continued (foled) header value from the previous line
@@ -376,7 +347,7 @@ module Sisimai
           lhs.downcase!
           previousfn = ''
 
-          next unless RFC822Head.key?(lhs)
+          next unless RFC822Head[lhs]
           previousfn = lhs
           headerpart[previousfn] = rhs unless headerpart[previousfn]
         end
@@ -520,7 +491,7 @@ module Sisimai
           argvs['tryonfirst'].concat(DefaultSet)
           while r = argvs['tryonfirst'].shift do
             # Try MTA module candidates
-            next if haveloaded.key?(r)
+            next if haveloaded[r]
             require r.gsub('::', '/').downcase
             parseddata = Module.const_get(r).make(mailheader, bodystring)
             haveloaded[r] = true
@@ -547,80 +518,6 @@ module Sisimai
       return parseddata
     end
 
-    # Parse bounce object with each MTA(JSON) module
-    # @param               [Hash] argvs    Processing message entity.
-    # @param options argvs [Hash] json     Decoded bounce object
-    # @param options argvs [Proc] hook     Hook method to be called
-    # @return              [Hash]          Parsed and structured bounce mails
-    def self.adapt(argvs)
-      Sisimai::Message.warn(self.name, 'gone')
-      bouncedata = argvs['json'] || {}
-      hookmethod = argvs['hook'] || nil
-      havecaught = nil
-      haveloaded = {}
-      parseddata = nil
-
-      # Call the hook method
-      if hookmethod.is_a? Proc
-        # Execute hook method
-        begin
-          p = {
-            'datasrc' => 'json',
-            'headers' => nil,
-            'message' => nil,
-            'bounces' => argvs['json']
-          }
-          havecaught = hookmethod.call(p)
-        rescue StandardError => ce
-          warn ' ***warning: Something is wrong in hook method :' << ce.to_s
-        end
-      end
-
-      catch :ADAPTOR do
-        while true
-          # 1. User-Defined Module
-          # 2. MTA(JSON) Module Candidates to be tried on first
-          # 3. Sisimai::Lhost::*
-          #
-          argvs['tobeloaded'].each do |r|
-            # Call user defined MTA(JSON) modules
-            next if haveloaded[r]
-            begin
-              require r.gsub('::', '/').downcase
-            rescue LoadError => ce
-              warn ' ***warning: Failed to load ' << ce.to_s
-              next
-            end
-            parseddata = Module.const_get(r).json(bouncedata)
-            haveloaded[r] = true
-            throw :ADAPTOR if parseddata
-          end
-
-          break # as of now, we have no sample JSON data for coding this block
-        end
-      end
-      return nil unless parseddata
-      return nil unless parseddata['ds']
-
-      parseddata['catch'] = havecaught
-      parseddata['ds'].each { |e| e['agent'].sub!(/\AEmail::/, 'JSON::') }
-      return parseddata
-    end
-
-    # @abstract Print warnings about an obsoleted method. This method will be
-    #           removed at the future release of Sisimai
-    # @until    v4.25.5
-    def self.warn(whois = '', useit = nil)
-      label = ' ***warning:'
-      methodname = caller[0][/`.*'/][1..-2]
-      messageset = sprintf("%s %s.%s is marked as obsoleted", label, whois, methodname)
-
-      useit ||= methodname
-      messageset << sprintf(" and will be removed at %s.", Sisimai::Lhost.removedat)
-      messageset << sprintf(" Use %s.%s instead.\n", self.name, useit) if useit != 'gone'
-      Kernel.warn messageset
-    end
-
   end
 end